Appendix C.
Methods Index


NOTE: See Appendix B for methods that get and set property values. See Appendix D for methods that return an object ID in the form IdentObj.

Return Value

Method

Description

void

_paint

Reserved for Internal/Future Use

void

actionPerformed()

Reserved for Internal/Future Use

int

addExceptionalOffset(

Reserved for Internal/Future Use

void

addPerspectiveListener()

Add a perspective listener

void

announceLicense()

Send license information to SysOut

void

askForRelease()

Ask Java to reclaim memory used by Perspective

void

beginDrawProcess()

Reserved for Internal/Future Use

void

calcWithoutDrawing

"dry run the graph" equivalent in PGSDK.

void

chartCreationFailed()

Reserved for Internal/Future Use

void

clearDataLabels()

Clear labels from the look, not the data

void

clearDataStorage()

Clear all data storage from a chart

void

clearGroupLabels()

Clear group labels from the chart

void

clearSeriesLabels()

Clear series labels from the chart

void

clearZoomList()

Clear the current zoom list

void

copyImageMap

Creates a copy of an ImageMap.

Detectiv

getDetectiv()

Reserved for Internal/Future Use

void

doZoomIn()

Zoom in on the chart

void

doZoomOut()

Zoom out from the chart

void

drawBadDog()

Method in BadDogCallback Interface. Reserved for Internal/Future Use

void

errorEvent()

Reserved for Internal/Future Use

void

focusCube()

Reserved for Internal/Future use

Vector

getAllLabels()

Get all the labels at the specified level.

Applet

getApplet()

Used by Java development to get the context for the Perspective applet

boolean

getAutofit()

Get autofit mode

int

getAutoSkip()

Get label automatic skip mode

int

getAxisAssignment()

Get axis assignment

boolean

getAxisDescending()

Get axis descending

int

getAxisSide()

Get axis side

BadDogCallback

getBadDogCallBack()

Method in BadDogCallback Interface. Reserved for Internal/Future Use

Color

getBorderColor()

Get the border color of an object

boolean

getChartDataValid()

Determine if chart data is valid

boolean

getChartFromFTP()

Get a chart from an FTP server

synchronized int

getChartState()

Reserved for Internal/Future Use

Matrix3d

getCubeRotationMatrix()

Get the rotation matrix of the 3D cube

int

getCurveFitPolynomialOrder()

Get polynomial order for a curve fit line.

int

getCurveFitType()

Get the curve fit type.

double

getDataAsDouble ()

Get data at row/col as double

String

getDataAsString ()

Get data at row/col as a string

int

getDataCoord()

Get data coordinates

double

getDataFromCoord()

Get data from coordinates

TDGDataGrid

getDataGridCallback()

Get the TDGDataGrid interface defined by setDataFromDataGrid()

String

getDataLabel()

Get the data label at series/group

Object

getDataObject()

Method in TDGEvent Class. Get data Object.

Rectangle

getDataRange()

Get the range of data in a chart

int

getDataTextAngle()

Get data text angle

int

getDataTextRadius()

Get data text radius

double

getDataValue()

Get data value assigned to the object identified by id

Detectiv

getDetectiv()

Reserved for Internal/Future Use

boolean

getDisplay()

Get the display mode of an object

boolean

getDisplayOffScale()

Get display offscale mode

URL

getDocumentBase()

Get document URL

int

getEffectiveColorMode()

Returns the actual color mode used.

int

getEffectiveGroupOffset()

Get the effective group offset

int

getEffectiveSeriesOffset()

Get the effective series offset

int

getEffectiveViewableGroups()

Get the effective number of viewable groups

int

getEffectiveViewableSeries()

Get the effective number of viewable series

Hashtable

getExceptionalRisers()

Determine if there are any exceptional risers

boolean

getExcludeMaxLabel()

Determine if maximum label is imaged on an axis

boolean

getExcludeMinLabel()

Determine if minimum label is imaged on an axis

Color

getFillColor()

Get fill color

int

getFillType()

Get fill type

String

getFontName()

Get the font name assigned to a text object

int

getFontSize()

Get the font size in destination coordinates.

int

getFontSizeVC()

Get the font size in virtual coordinates

int

getFontStyle()

Get the font style of a text object

Point

getFrameDepthOffset()

Get frame depth offset

Rectangle

getFrameRect( )

Get the size and location of the chart frame

int

getGradientDirection()

Get the gradient direction

int

getGradientNumPins()

Get the number of pins in a gradient

Color

getGradientPinLeftColor()

Get the left color used by the gradient pin

double

getGradientPinPosition()

Get the gradient pin position

Color

getGradientPinRightColor()

Get the right color used by the gradient pin

JChart_Base

getGraphObject()

Reserved for Internal/Future Use

int

getGridCount()

Get grid count

double

getGridStep()

Get number of grid steps on an axis

boolean

getGridStepAuto()

Determine if grid steps are automatically calculated

int

getGridStyle()

Get style of grid lines assigned to an axis

String

getGroupLabel()

Get a group label

boolean

getIgnoreSeries()

Determine if a series is ignored

int

getID()

Method in TDGEvent Class. Get ID associated with an event.

JGraphType

getJGraphType()

Reserved for Internal/Future use

String

getLabel()

Get string specified by the group and level.

int

getLabelGrouping()

Get the number of labels grouped

int

getLabelMargin()

Get the margin assigned to a label

boolean

getLabelStagger()

Determine if staggered labels are used

int

getLegendMinWidth()

Get the minimum legend width

int

getLegendOrient()

Get the orientation of the legend object

Rectangle

getLegendRect()

Get the size and location of the legend area

int

getLineWidth ()

Get the width of a line

Locale

getLocale()

Inherited by Perspective from Java Components

boolean

getLogScale()

Get logarithmic/linear scaling assigned to an axis

double

getLogScaleBase()

Get logarithmic scale base

int

getMarkerShape()

Get marker shape

int

getMarkerSize()

Get marker size

MarkerTemplate

getMarkerTemplate()

Get a marker template

Dimension

getMinimumSize()

Get the minimum size of a chart

int

getNextMarkerTemplateSlot()

Get the next marker template slot

NumberFormat
CallBack

getNumberFormatCallBack()

Determine if a NumberFormatCallBack has been assigned with setNumberFormatCallBack()

int

getNumGroups()

Get the number of groups in the chart

int

getNumLabelsOnLevel()

Get the number of labels on the specified level.

int

getNumLevels()

Get the number of nested lables.

int

getNumNonIgnoredSeries();

Get the number of the series in the chart that are not ignored.

int

getNumSeries()

Get the number of series in the chart

int

getNumTotalGroups()

Get the total number of groups in the chart

int

getNumTotalSeries()

Get the total number of series in the chart

TDGNestedLabel

getO1LabelCallBack()

Get the value assigned to the O1 nested labels callback

int

getObjectFromLevel()

Static method in class tdg.ObjClassID. Reserved for Internal/Future Use.

ObjClassID

getObjMethodName()

Method in ObjClassID class. Reserved for Internal/Future Use.

String

getPieBarLabel()

Establish the chart Title.

boolean

getPieSliceDelete()

Determine if a pie slice is deleted

int

getPieSliceDetach()

Determine if a pie slice is detached

TDGPreScaleIF

getPreScaleCallback()

Reserved for Internal/Future Use

int

getQuadrantLineValueX()

Get vertical location of the X quadrant line

int

getQuadrantLineValueY()

Get horizontal location of the Y quadrant line

Rectangle

getRect()

Get size and location of an object

double

getScaleMax()

Get scale maximum value

boolean

getScaleMaxAuto()

Get automatic maximum scaling

double

getScaleMin()

Get minimum scale value

boolean

getScaleMinAuto()

Get automatic minimum scaling

boolean

getScaleMustIncludeZero()

Get scale must include zero

Vector

getSelection()

Get a vector of selection objects

Color

getSelectionBorderColor()

Get the border color of the currently selected object

Color

getSelectionFillColor()

Get the fill color of the currently selected object

int

getSelectionLineWidth()

Get the line width of the first item in the selection list

int

getSelectionSize()

Get the size of the first item in the selection list

int

getSelGroup()

Get the group of the currently selected object

int

getSelSeries()

Get the series of the currently selected object

Color

getSeriesBorderColor()

Get the border color of a series

Color

getSeriesFillColor()

Get the fill color of a series

String

getSeriesLabel()

Get series label

int

getSeriesType()

Get series type

Color

getShadowColor()

Get the Shadow Color of an object

boolean

getShadowDisplay()

Determine if a shadow has been applied to an object

int

getShadowXOffset()

Get shadow X-Offset

int

getShadowYOffset()

Get shadow Y-Offset

int

getSkipBegin()

Get label skip beginning number

int

getSkipCount()

Get label skip count

Object

getSource()

Method in TDGEvent Class. Get the Source where this event originated.

String

getTextFormatPattern()

Get text format pattern

int

getTextFormatPreset()

Get text format preset

int

getTextJustHoriz()

Get text horizontal justification

int

getTextJustVert()

Get text vertical justification

int

getTextRotation()

Get text rotation

String

getTextString()

Get text string

String

getTexture()

Get texture

int

getTextureDisplayMode()

Get texture display mode assigned to object id

boolean

getTextWrap()

Get text wrap mode (on or off)

ToolTipCallBack

getToolTipCallBack()

Determine if a tool tip callback has been assigned with setToolTipCallBack()

String

getToolTipCustomString()

Obsolete

boolean

getTransparentBorderColor()

Get transparent border color

boolean

getTransparentFillColor()

Get transparent fill color

TDGDataCallbackIF

getTrueDataCallback()

Reserved for Internal/Future Use

String

getURL()

Get Universal Resource Locator

String

getURLTarget()

Get Frame Target for URL

VC

getVC()

Reserved for Internal/Future Use

DataRange

getViewableDataRange()

Get the viewable data range

DataRange

getViewableDataRangeSG()

Get the data range (in series and groups) that will actually be graphed

double

getX1MajorGridStepAutoValue()

Get automatically calculated major grid steps on the X-Axis.

double

getX1ScaleMaxAutoValue()

Get automatically calculated maximum scale value on the X-Axis.

double

getX1ScaleMinAutoValue()

Get automatically calculated minimum scale value on the X-Axis.

double

getY1MajorGridStepAutoValue()

Get automatically calculated major grid steps on the Y1-Axis.

double

getY1ScaleMaxAutoValue()

Get automatically calculated maximum scale value on the Y1-Axis.

double

getY1ScaleMinAutoValue()

Get automatically calculated minimum scale value on the Y1-Axis.

double

getY2MajorGridStepAutoValue()

Get automatically calculated major grid steps on the Y2-Axis.

double

getY2ScaleMaxAutoValue()

Get automatically calculated maximum scale value on the Y2-Axis.

double

getY2ScaleMinAutoValue()

Get automatically calculated minimum scale value on the Y2-Axis.

int

getZoomIndex()

Get the most recent entry in the zoom list

ZoomStateList

getZoomList()

Reserved for Internal/Future Use

boolean

hasBarOrMarkerSeries()

Does the chart contain a series displayed as a Bar or Line-with-markers?

void

inputParamString ()

HTML Parsing interface

void

insertGradientPin()

Insert a gradient pin

boolean

isApplet()

Reserved for Internal/Future use

boolean

isChart3DType()

Determine whether or not the current chart is one of the 3D graphs

boolean

isChartBiPolar()

Determine whether or not the current chart is bi-polar

boolean

isChartBLAType()

Determine whether or not the current chart is a Bar, Line, or Area Chart.

boolean

isChartDualY()

Determine whether or not the current chart is a dual-axes chart

boolean

isChartOrientHorz()

Determine whether or not the current chart is horizontal (false=vertical chart)

boolean

isChartPieType()

Determine whether or not the current chart is one of the pie charts

boolean

isChartReady()

Reserved for Internal/Future use

boolean

isChartScatter()

Determine whether or not the current chart is a scatter chart.

boolean

isChartStockType()

Determine whether or not the current chart is one of the stock charts.

boolean

isColorByGroup()

Determine whether or not the chart is colored by group

boolean

isColorByHeight()

Determine if chart is colored by height

boolean

isExceptional

Reserved for Internal/Future Use

boolean

isExceptionalAllowed()

Determine if excpetional risers are allowed

boolean

isFocusTraversable()

Reserved for Internal/Future Use

boolean

isGroupScrollerPresent()

Determine if the group data scroller bar is present

boolean

isNumberFormatCallBack()

Determine if the object is a number format callback

boolean

isO1AxisPresent()

Determine if the O1 axis is present in the chart

boolean

isO2AxisPresent()

Determine if the O2 axis is present in the chart

boolean

isSelection()

Determine if there are any items in the selection list

boolean

isSelectionBorderColorTransparent()

Determine if the first item in the selection list has a transparent border color

boolean

isSelectionCube()

Determine if the first item in the selection list is a 3D cube

boolean

isSelectionDataLabel()

Determine if the first item in the selection list is a data label object

boolean

isSelectionFillColorTransparent()

Determine if the first item in the selection list has a transparent fill color

boolean

isSelectionGridLine()

Determine if the first item in the selection list is a grid line

boolean

isSelectionLegend()

Determine if first item in the selection list is the legend area

boolean

isSelectionLine()

Determine if the first item in the selection list is a line

boolean

isSelectionRiser()

Determine if the first item in the selection list is a riser

boolean

isSelectionSeriesRelated()

Determine if the first item in the selection list is series related

boolean

isSelectionText()

Determine if first item in the selection list is a text object

boolean

isSeriesScrollerPresent()

Determine if the series scroller bar is present

boolean

isSQLTypeNumeric()

Determine if the value is an SQL Numeric data type

boolean

isSQLTypeString()

Determine if the string is an SQL String data type

boolean

isToolTipCallBack()

Determine if the object is a tool tip callback

boolean

isValidChart()

Method in BadDogCallback Interface. Reserved for Internal/Future Use

boolean

isValidZoomIndex ()

Determine if a particular data zooming index is valid

boolean

isX1AxisPresent()

Determine if the X1 axis is present in the chart

boolean

isY1AxisPresent()

Determine if the Y1 axis is present in the chart

boolean

isY2AxisPresent()

Determine if the Y2 axis is present in the chart

boolean

isZ1AxisPresent()

Determine if the Z1 axis is present in the chart

boolean

isZoomingArmed()

Determine if doZoomIn() or doZoomOut() has been called

void

keyPressed()

Reserved for Internal/Future use

void

keyReleased()

Reserved for Internal/Future use

void

keyTyped()

Reserved for Internal/Future use

void

load()

Load a chart from an input stream or URL

void

mouseClicked()

Reserved for Internal/Future use

void

mouseDragged()

Reserved for Internal/Future use

void

mouseEntered()

Reserved for Internal/Future use

void

mouseExited()

Reserved for Internal/Future use

void

mouseMoved()

Reserved for Internal/Future use

void

mousePressed()

Reserved for Internal/Future use

void

mouseReleased()

Reserved for Internal/Future use

void

needRecalc()

Reserved for Internal/Future use

void

notifyChartDataInvalid()

Reserved for Internal/Future use

boolean

optimizeData()

Ask the chart to optimize the data.

String

outputParamString()

Get a list of chart parameters

void

print ( )

Reserved for Internal/Future use

void

paint ()

Reserved for Internal/Future use

void

paintComponent()

Reserved for Internal/Future use

int

registerMarkerTemplate ( )

Register a user-defined marker template

void

reloadOriginalData()

Called when the "original data" should be reloaded.

void

removePerspectiveListener()

Remove a Perspective listener

void

resetNonMatrixTransformParameters()

Reserved for Internal/Future Use

void

restoreAllSlices()

Restore all deleted/detached slices from a pie

void

restoreDefaults()

Restore all default values

void

rotateCubeX()

Reserved for Internal/Future use

void

rotateCubeY()

Reserved for Internal/Future use

void

rotateCubeZ()

Reserved for Internal/Future use

void

save()

Save a chart to an output stream

void

saveNonMatrixTransformParameters()

Reserved for Internal/Future Use

void

scaleCube(double scaleFactor)

Reserved for Internal/Future use

boolean

sendChartToFTP( )

Send a chart to an FTP server

void

sendGIFToFile( )

Send a chart to a file as a .GIF file

void

sendGIFToFTP()

Send a chart to an FTP server as a .GIF file

void

sendGIFToStream()

Send a chart to an output stream as a .GIF file

void

sendImageMapToStream ( )

Send an image map to a stream

void

sendPNGToFile

Writes the chart image to the file specified, in .png format.

void

sendPNGToStream

Writes the chart image to the stream specified, in .png format.

void

setAutofit()

Set/clear automatic fitting

void

setAutoSkip()

Set label skip mode

void

setAxisAssignment()

Set axis assignment

void

setAxisDescending()

Set axis ascending/descending

void

setAxisSide()

Set axis side

void

setBadDogCallback()

Method in BadDogCallback Interface. Reserved for Internal/Future Use

void

setBorderColor()

Set border color

void

setBounds

Inherited by Perspective from Java Components.

void

setCubeRotationMatrix()

Set the rotation matrix of the 3D cube

void

setCurveFitPolynomialOrder()

Set polynomial order for a curve fit line.

void

setCurveFitType()

Set the curve fit type.

void

setData()

Set data in a chart

void

setDataFileURL()

Load a text file from any valid file or Internet URL

void

setDataFromCallBack()

Load data from call back

void

setDataFromDataGrid()

Load data from a data grid

void

setDataFromResultSet()

Load data from an SQL Result set

void

setDataFromSQL()

Load data from SQL

void

setDataLabel()

Assign a data label to a series/group

void

setDataRange()

Set the range of data to be imaged

void

setDataRangeToExtent()

Set the data range to the values set by setData()

void

setDataStream()

Set data stream

void

setDataTextAngle()

Set the angle of data text

void

setDataTextRadius()

Set data text radius

void

setDataValue()

Assign a data value to an object

void

setDeveloperToolTip();

Set developer-mode custom tool tip

void

setDeveloperToolTipDefault()

Select developer-mode default tool tips

void

setDisplay()

Enable/disable display of an object

void

setDisplayOffScale()

Set display off scale

void

setDynamicToolTip ()

Define a dynamic tool tip string

void

setEditChart()

Reserved for Internal/Future use

void

setEditZoom()

Reserved for Internal/Future use

void

setExceptionalRiser()

Set exceptional risers

void

setExcludeMaxLabel()

Exclude/Include maximum label on an axis

void

setExcludeMinLabel()

Exclude/Include minimum label on an axis

void

setFillColor()

Set the fill color of an object

void

setFillType()

Set fill type

void

setFontName()

Set font name

void

setFontSize()

Set font size

void

setFontSizeVC()

Set font size in virtual coordinates

void

setFontStyle()

Set font style

void

setGradientDirection()

Set gradient direction

void

setGradientNumPins()

Set number of pins in a gradient

void

setGradientPinLeftColor()

Set gradient pin left color

void

setGradientPinPosition()

Set gradient pin position

void

setGradientPinRightColor()

Set gradient pin right color

void

setGridCount()

Set grid count

void

setGridStep()

Set number of grid steps

void

setGridStepAuto()

Enable/Disable automatic calculation of grid steps

void

setGridStyle()

Set the style of grid lines

void

setGroupLabel()

Define a group label

void

setIgnoreSeries()

Include/Exclude a series in a chart

void

setLabelMargin()

Enable/Disable label margins

void

setLabelStagger()

Enable/Disable staggered labels

void

setLegendOrient()

Set the orientation of the legend area

void

setLegendRect()

Set the location and size of the legend area

void

setLineWidth()

Set line width

void

setLocale()

Inherited by Perspective from Java Components.

void

setLogScale()

Set logarithmic/linear scaling

void

setLogScaleBase()

Set logarithmic scale base

void

setMarkerShape()

Set the shape of a marker

void

setMarkerSize()

Set marker size for the first item in the selection list

void

setMarkerTemplate()

Define a custom marker shape

void

setNoExceptionalRiser()

Disallow exceptional risers

void

setNumberFormatCallBack ()

Set a number format callback

void

setO1LabelCallback ()

Set a callback for O1-axis nested labels

void

setPieSliceDelete()

Set/clear deleted pie slice

void

setPieSliceDetach()

Set distance a slice is detached from a pie chart

void

setQuadrantLineValueX()

Set scale value at which to place vertical quadrant line

void

setQuadrantLineValueY()

Set scale value at which to place horizontal quadrant line

void

setRect()

Set the location and size of an object

void

setScaleMax()

Assign a maximum scale value

void

setScaleMaxAuto()

Enable/Disable automatic calculation of the maximum scale value

void

setScaleMin()

Assign a minimum scale value

void

setScaleMinAuto()

Enable/Disable automatic calculation of the minimum scale value

void

setScaleMustIncludeZero()

Enable/Disable zero on scale

void

setSelection ()

Select part of a chart at the API Level

void

setSeriesAreRows ()

Assign a value to the SeriesAreRows property and enable/disable swapping of labels.

void

setSeriesBorderColor()

Assign a border color to a series

void

setSeriesFillColor()

Assign a fill color to a series

void

setSeriesLabel()

Assign a series label

void

setSeriesType()

Assign a series type

void

setShadowColor()

Assign a shadow color to an object

void

setShadowDisplay()

Enable/Disable shadow display

void

setShadowXOffset()

Set shadow X-offset

void

setShadowYOffset()

Set shadow Y-offset

void

setSize()

Inherited by Perspective from Java Components

void

setSkipBegin()

Assign a label skip begin value

void

setSkipCount()

Assign a label skip interval

void

setState()

Reserved for Internal/Future use

void

setTextFormatPattern()

Assign a standard Java text format pattern

void

setTextFormatPreset()

Assign a preset text format

void

setTextJustHoriz()

Set text horizontal justification

void

setTextJustVert()

Set text vertical justification

void

setTextRotation()

Set text rotation

void

setTextString()

Set text string

void

setTextureDisplayMode()

Set texture display mode

void

setTextureURL ()

Load a texture from a URL

void

setTextWrap()

Set text wrap mode

void

setToolTipCallBack ()

Set a tool tip callback function

void

setToolTipCustomString()

Replaced by setDeveloperToolTip() and setUserToolTip()

void

setToolTipOff()

Disable tool tip event generation

void

setToolTipOn()

Enable tool tip event generation

void

setTransparentBorderColor()

Set transparent border color

void

setTransparentFillColor()

Set transparent fill color

TDGDataCallbackIF

setTrueDataCallback()

Reserved for Internal/Future Use

void

setURL()

Set URL

void

setURLTarget()

Set the Frame Target for a URL

void

setUserToolTip()

Set user-mode custom tool tip string

void

setUserToolTipDefault()

Select default user-mode tool tips

void

setZoomIndex()

Set the current zoom index in the zoom list

void

startListeners()

Reserved for Internal/Future use

void

stopListeners()

Reserved for Internal/Future use

int

stripExceptionalOffset()

Reserved for Internal/Future use

void

toggleEditControls()

Turn on/off edit controls in the Three |D| Graphics user interface

void

translateCube()

Reserved for Internal/Future use

void

update( )

Reserved for Internal/Future use

void

updateAccess()

Reserved for Internal/Future use

void

updateParamsFromMatrix()

Reserved for Internal/Future use