getApplet()

This method returns the current applet or null if being used with an application. If you need to get a context for a getDocumentBase in a Java environment, this method returns the location for this instance of Perspective.

Syntax:

Applet getApplet();

Input:

None

Return:

Applet: the current applet

getAutofit()

This method can be used to determine if a text object is automatically fitted and sized. If an object is not identified by id or objectID, this method returns the autofit attribute for the first item in the selection list. You may also use one of the object-specific properties to get the autofitting attribute of an object (e.g., FootnoteAutofit, LegendTextAutofit, O1LabelAutofit, etc.).

Syntax:

boolean getAutofit ();

boolean getAutofit(tdg.draw.IdentObj id);

boolean getAutofit(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getFootnote())

objectID: Object Number

Return:

boolean: true/false

 

true=

Autofit enabled

 

false=

Autofit disbled

Also See:

setAutofit(), FootnoteAutofit, LegendTextAutofit, O1LabelAutofit,
O1TitleAutofit, O2LabelAutofit, O2TitleAutofit, X1LabelAutofit,
X1TitleAutofit, Y1LabelAutofit, Y1TitleAutofit, Y2LabelAutofit,
Y2TitleAutofit

getAutoSkip()

This method can be used to determine the skipping mode that may be assigned to primary ordinal (O1) axis labels. If an object is not identified by id or objectID, this method returns the auto-skipping attribute for the first item in the selection list. You may also use the object-specific property to determine label skip mode (e.g., O1LabelAutoSkip).

Syntax:

int getAutoSkip();

int getAutoSkip(tdg.draw.IdentObj id);

int getAutoSkip(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

objectID: Object Number

Return:

int: 0...2

 

0=

No label skipping

 

1=

Automatic label skip

 

2=

Manual skip

Example:

perspective1.setViewableSeries(4);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setViewableGroups(4);
perspective1.setDepthRadius(0);
int i = perspective1.getAutoSkip();
if (i==0)perspective1.setO1LabelAutoSkip(2);
perspective1.setO1LabelSkipBegin(1);
perspective1.setO1LabelSkipCount(1);

Also See:

setAutoSkip(), O1LabelAutoSkip

getAxisAssignment()

In dual-axis charts, this method can be used to determine if a series is assigned to theY1 or Y2 axis.

Syntax:

int getAxisAssignment ();

int getAxisAssignment(tdg.draw.IdentObj id);

int getAxisAssignment(int SeriesID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

seriesID = Series Number

Return:

int: 0/1

 

0=

Y1

 

1=

Y2

Example:

perspective1.setViewableSeries(4);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setGraphType(21);
perspective1.setViewableGroups(4);
perspective1.setDepthRadius(0);
int i = perspective1.getAxisAssignment(2);
if (i==0)perspective1.setAxisAssignment(2,1);

Also See:

setAxisAssignment(), getAxisDescending(), setAxisDescending(),
getAxisSide(), setAxisSide(), Y1AxisSide, Y2AxisSide

getAxisDescending()

This method can be used to determine if a numeric axis is drawn in ascending or descending order. If a specific numeric axis is not identified by id or objectID, the method gets the axis-descending attribute for the first item in the selection list. You may also use one of the axis-specific properties (e.g., X1AxisDescending, Y1AxisDescending, etc.) to get the descending attribute of an axis.

Syntax:

boolean getAxisDescending()

boolean getAxisDescending(tdg.draw.IdentObj id);

boolean getAxisDescending(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

Return:

boolean: true/false

 

true=

Descending

 

false=

Ascending

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
boolean b = perspective1.getAxisDescending(
    perspective1.getY1Axis());
if (b==false) perspective1.setAxisDescending(
    perspective1.getY1Axis(),true);

Also See:

setAxisDescending(), getAxisAssignment(), setAxisAssignment(),
getAxisSide(), setAxisSide(), X1AxisDescending, Y1AxisDescending,
Y2AxisDescending

getAxisSide()

This method can be used to determine where an axis is imaged in the chart. You may also use one of the axis-specific properties (e.g., X1AxisSide, Y1AxisSide, etc.) to determine where an axis is imaged.

Syntax:

int getAxisSide ();

int getAxisSide(tdg.draw.IdentObj id);

int getAxisSide(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

Return:

int: 0...2

 

0=

Left in vertical charts/Bottom in horizontal charts

 

1=

Right in vertical charts/Top in horizontal charts

 

2=

Both sides of chart

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
int i = perspective1.
    getAxisSide(perspective1.getY1Axis());
if (i==0)perspective1.setAxisSide(
    perspective1.getY1Axis(),1);

Also See:

setAxisSide(), getAxisAssignment(), setAxisAssignment(),
getAxisDescending(), setAxisDescending(), O1AxisSide, X1AxisSide,
Y1AxisSide, Y2AxisSide

getBorderColor()

This method gets the border color of an object.

Syntax:

java.awt.color getBorderColor (tdg.draw.IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getBarRiser())

Return:

color: A color value

Also See:

setBorderColor(), getFillColor(), setFillColor(), getSelectionBorderColor(),
getTransparentBorderColor(), setTransparentBorderColor(),
isSelectionBorderColorTransparent(), setSeriesBorderColor(), ColorMode.

getChartDataValid()

This method can be used to determine whether or not chart data is valid.

Syntax:

boolean getChartDataValid();

Input:

None

Return:

boolean: true/false

 

true=

Chart data is valid

 

false=

Data not valid

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
boolean b = perspective1.getChartDataValid();
if (b==true)perspective1.setGraphType(18);

 

 

 

getChartFromFTP()

This method gets a chart from an FTP server.

Syntax:

boolean getChartFromFTP (
    java.lang.String strHost,
    java.lang.String strUser,
    java.lang.String strPass,
    java.lang.String strDir,
    java.lang.String strOrgFile
);

Input:

strHost: Host Name

strUser: User Name

strPass: Password

strDir: Directory location

strOrgFile: File Name

Return:

boolean: true/false

 

true=

Success

 

false=

Failed

Also See:

sendChartToFTP(), sendGIFToFTP()

getCubeRotationMatrix()

This method gets the rotation matrix of the cube in a 3D chart.

Syntax:

tdg.model3d.Matrix3d getCubeRotationMatrix();

Input:

None

Return:

Matrix3d;

 

class Matrix3d implements java.io.Serializable
{
    double m00;// row 0, col 0
    double m01;// row 0, col 1
    double m02;
    double m10;
    double m11;
    double m12;
    double m20;
    double m21;
    double m22;
}

Also See:

setCubeRotationMatrix()

getCurveFitPolynomialOrder()

If the setCurveFit() method selects a polynomial fit line across a series of risers (i.e., setCurveFit(FIT_POLYNOMIAL)), this method gets the value that is assigned with the setCurveFitPolynomialOrder() method. The setCurveFitPolynomialOrder() method sets the order (the largest power to which "x" is raised) for the polynomial fit. The default value is 3. It may be set to a value in the range 0...10.

Syntax:

int getCurveFitPolynomialOrder()

int getCurveFitPolynomialOrder(tdg.draw.IdentObj id)

int getCurveFitPolynomialOrder(int seriesID)

Input:

id; IdentObj returned by a getObjectID() method (e.g., getSeries())

seriesID; Series Number

Return:

int; Value assigned by setCurveFitPolynomialOrder()

Example:

perspective1.setDepthRadius(0);
perspective1.setCurveFitType(1,3);
int i = perspective1.getCurveFitPolynomialOrder();
perspective1.setCurveFitPolynomialOrder(i+10);

 

Also See:

setCurveFitPolynomialOrder(), getCurveFitType(), setCurveFitType()

getCurveFitType()

This method gets the value assigned by the setCurveFitType() method. This setCurveFitType() method selects a curve fit line and draws the selected curve type across one or more series of risers in a chart.

int getCurveFitType()

int getCurveFitType(tdg.draw.IdentObj id)

int getCurveFitType(int seriesID)

Input:

id; IdentObj returned by a getObjectID() method (e.g., getSeries())

seriesID; Series Number

Return:

int; The curve fit type selected by setCurveFitType()

CurveFitType Constant

Value

Description

FIT_NONE

0

None

FIT_LINEAR

1

Linear regression curve fit line

FIT_QUADRATIC

2

Quadratic curve fit line

FIT_POLYNOMIAL

3

Polynomial fit line

FIT_HYPERBOLIC

4

Hyperbolic curve fit line

FIT_LOGARITHMIC

5

Logarithmic curve fit line

FIT_MODHYPERBOLIC

6

Modified hyperbolic

FIT_RATIONAL

7

Rational curve fit line

FIT_EXPONENTIAL

8

Exponential curve fit line

FIT_MODEXPONENTIAL

9

Modified exponential

FIT_LOGQUADRATIC

10

Logarithmic/Quadratic curve fit line

FIT_GEOMETRIC

11

Geometric curve fit line

Also See:

setCurveFitType(), CurveFitEquationDisplay, CurveFitHighOrderFirst

getDataAsDouble()

This method gets the numeric value for any row/column intersection.

Syntax:

java.lang.double getDataAsDouble (
    int row,
    int col
); throws tdg.AssertionException

Input:

row: Row from which to retrieve data

col: Column from which to retrieve data

Return:

double = the data at the specified row and column

Also See:

getDataAsString()

getDataAsString()

This method gets a value for any series/group intersection and converts it to a string.

Syntax:

java.lang.string getDataAsString (int row, int col); throws tdg.AssertionException

Input:

row: Chart row from which to get value

col: Chart column from which to get value

Return:

string: Character string at row,col

Example:

perspective1.setScrollOffsetGroup(0);
perspective1.setScrollOffsetSeries(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setGroupLabel(0,getDataAsString(0,0));
perspective1.setGroupLabel(1,getDataAsString(0,1));
perspective1.setGroupLabel(2,getDataAsString(0,2));
perspective1.setLegendDisplay(false);

Also See:

getDataAsDouble()

getDataCoord()

This method can be used to determine the location of an object in a chart.

Syntax:

int getDataCoord (IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getLegendArea())

Return:

int = x,y coordinates of an object in a chart

Also See:

getDataFromCoord()

getDataFromCoord()

This method gets a data value for an object at a specified coordinates in a chart.

Syntax:

double getDataFromCoord (
    IdentObj id,
    int nCoordVC
);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

nCoordVC: Virtual coordinance of object

Return:

double = the data at the specified coordinates

Also See:

getDataCoord()

getDataGridCallback()

This method returns the TDGDataGrid interface defined by the setDataFromDataGrid() method.

Syntax:

TDGDataGrid getDataGridCallback()

Input:

None

Return:

TDGDataGrid; The TDGDataGrid interface defined by setDataFromDataGrid()

Also See:

setDataFromDataGrid()

getDataLabel()

This method gets a label string at a specified series (s) and group (g).

Syntax:

String getDataLabel (
    int s,
    int g
);

Input:

s: Series number

g: Group number

Return:

String = the data label at series (s)/group (g)

Also See:

getGroupLabel(), setGroupLabel(), getSeriesLabel(), setSeriesLabel(). For HTML ONLY, see setSeriesLabelArray() and setGroupLabelArray() in Chapter 4.

getDataObject()

This method returns the dataObject associated with the current event.

Syntax:

java.lang.Object getDataObject()

Input:

None

Return:

Object; dataObject associated with the current event.

Notes:

This method is defined in the TDGEvent class.

Also See:

getID(), getSource(), addPerspectiveListener(), perspectiveEvent()

getDataRange()

This method returns a rectangle that represents the current range of data viewed/charted in a graph.

Syntax:

java.awt.extents getDataRange ();

Input:

None

Return:

Rectangle.x = Starting Row

Rectangle.y = Starting Column

Rectangle.width = Ending Row

Rectangle.height = Ending Column

Also See:

setData(), setDataFileURL(), setDataFromCallBack(),
setDataFromDataGrid(), setDataFromResultSet(), setDataFromSQL(),
setDataRangeToExtent()

getDataTextAngle()

This method can be used to determine the angle from center point that all or selected data text is drawn. If a specific object is not identified by id or objectID, the method will return the value of this attribute for the first item in the selection list.

Syntax:

int getDataTextAngle ();

int getDataTextAngle(tdg.draw.IdentObj id);

int getDataTextAngle(int seriesID);

int getDataTextAngle(int seriesID,int groupID);

Input:

id: IdentObj returned by a getObject() method (e.g., getDataText())

seriesID: Series number

groupID: Group number

Return:

int: the data text angle (0...360)

Example:

perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataTextDisplay(true);
perspective1.setAutofit(perspective1.getDataText(),false);
perspective1.setFontSize(perspective1.getDataText(),8);
perspective1.setDataTextPosition(0);
perspective1.setDataTextAngleDefault(0);
int i = perspective1.getDataTextAngle();
perspective1.setDataTextAngle(i+90);

Notes:

The DataTextDisplay property must be set to true in order for data text to be drawn in the chart. The DataTextPosition property must be set to zero.

Also See:

setDataTextAngle(), getDataTextRadius(), setDataTextRadius(),
DataTextAngleDefault, DataTextDisplay, DataTextPosition

getDataTextRadius()

This method can be used to determine the radius for the data text position of a specified data point (series and group or series only). If a specific object is not identified by the input parameter id or objectID, the method will set or return the value of this attribute for the first item in the selection list.

Syntax:

int getDataTextRadius ();

int getDataTextRadius(tdg.draw.IdentObj id);

int getDataTextRadius(int seriesID);

int getDataTextRadius(int seriesID,int groupID);

Input:

id: IdentObj returned by a getObject() method (e.g., getDataText())

seriesID: Series number

groupID: Group number

Return:

int: the data text radius (0...100)

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataTextDisplay(true);
perspective1.setAutofit(perspective1.getDataText(),false);
perspective1.setFontSize(perspective1.getDataText(),8);
perspective1.setDataTextPosition(0);
int i = perspective1.getDataTextRadius();
perspective1.setDataTextRadius(i+90);

Notes:

DataTextDisplay must be set to true in order for data text to be drawn in the chart.

Also See:

setDataTextRadius(), getDataTextAngle(), setDataTextAngle(),
DataTextRadiusDefault, DataTextDisplay, DataTextPosition

getDataValue()

This method gets a data value for a data object (riser) in a chart.

Syntax:

double getDataValue (IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getBarRiser())

Return:

double = data value at id

getDisplay()

This method can be used to determine whether not an object is visible in in a chart. If a specific object is not identified by the input parameter id or objectID, the method will return the value of this attribute for the first item in the selection list.

Syntax:

boolean getDisplay();

boolean getDisplay(tdg.draw.IdentObj id);

boolean getDisplay (int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getFootnote())

objectID: Object Number

Return:

boolean: true/false

 

true=

Object is displayed

 

false=

Object is not displayed

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
boolean b = perspective1.getDisplay(
    perspective1.getDataText());
perspective1.setDisplay(perspective1.getSubtitle(),b);

Also See:

setDisplay()

getDisplayOffScale()

This method can be used to determine whether or not off scale data points are imaged in a chart. If a specific object is not identified by id or objectID, the off-scale display attribute will be set or returned for the first item in the selection list. You may also use one of the object-specific properties to determine the off-scale display attribute of a specific object (e.g., X1OffScaleDisplay, Y1OffScaleDisplay, etc.).

Syntax:

boolean getDisplayOffScale();

boolean getDisplayOffScale(tdg.draw.IdentObj id);

boolean getDisplayOffScale (int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

Return:

boolean: true/false

 

true=

Offscale values are imaged

 

false=

Offscale values are not drawn

Also See:

setDisplayOffScale(), X1OffScaleDisplay, Y1OffScaleDisplay,
Y2OffScaleDisplay

getDocumentBase()

This method gets the document URL.

Syntax:

URL getDocumentBase ();

Input:

None

Return

URL = document URL

 

 

 

getEffectiveColorMode()

 

The value assigned to the ColorMode property defines the basic color scheme for coloring riser objects in a chart. However, some chart types (3d surface) prefer color-by-height, some (3d connected groups) prefer color-by-height, and most prefer color-by-series. These preferences can usually but not always be overridden by an explicit ColorMode setting. This method returns the actual color mode used regardless of the ColorMode setting.

Syntax:

int getEffectiveColorMode()

Input:

None

Return:

int; 0...2

 

0=

Automatic. Use the group as the series if there is only one series. 3D Connected Series Ribbon and Areas are colored by series. 3D Group Ribbon and Areas are colored by group.

 

1=

Color by Series

 

2=

Color by Group

Also See:

ColorMode

 

 

getEffectiveGroupOffset()

 

This method can be used to determine whether or not data scrolling is being used in the chart. If this method returns a value greater than zero, it indicates the ViewableGroups and ScrollOffsetGroup properties are both set to a value greater than zero (i.e., not all groups in the data set are imaged). A value of zero indicates the number of imaged groups is the same as the number of groups in the data set (i.e., ViewableGroups=0) and/or ScrollOffsetGroup is set to zero.

Syntax:

int getEffectiveGroupOffset();

Input:

None

Return

int: Value assigned to ScrollOffsetGroup property.

Example:

perspective1.setDepthAngle(0);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableGroups(3);
perspective1.setScrollOffsetGroup(3);
int i = perspective1.getEffectiveGroupOffset();
if (i != 0)
{
    perspective1.setViewableSeries(i);
}
perspective1.setDepthRadius(0);

 

Also See:

getEffectiveSeriesOffset(), ViewableGroups, ScrollOffsetGroup

 

 

getEffectiveSeriesOffset()

 

This method can be used to determine whether or not data scrolling is being used in the chart. If this method returns a value greater than zero, it indicates the ViewableSeries and ScrollOffsetSeries properties are both set to a value greater than zero (i.e., not all series in the data set are imaged). A value of zero indicates the number of imaged series is the same as the number of series in the data set (i.e., ViewableSeries=0) and/or ScrollOffsetSeries is set to zero.

Syntax:

int getEffectiveSeriesOffset();

Input:

None

Return

int: Value assigned to ScrollOffsetSeries property.

Example:

perspective1.setDepthAngle(0);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableSeries(3);
perspective1.setScrollOffsetSeries(3);
int i = perspective1.getEffectiveSeriesOffset();
if (i != 0)
{
    perspective1.setViewableGroups(i);
}
perspective1.setDepthRadius(0);

 

Also See:

getEffectiveGroupOffset(), ViewableSeries, ScrollOffsetSeries

 

 

getEffectiveViewableGroups()

 

This method can be used to determine whether or not data scrolling is being used in the chart. If this method returns a value greater than zero, it indicates the ViewableGroups property is set to a value greater than zero (i.e., not all series in the data set are imaged). A value of zero indicates the number of imaged series is the same as the number of series in the data set (i.e., ViewableGroups=0).

Syntax:

int getEffectiveViewableGroups();

Input:

None

Return

int: Number of viewable groups in the chart.

Example:

perspective1.setDepthRadius(0);
int i = perspective1.getEffectiveViewableGroups();
perspective1.setViewableGroups(i-2);
perspective1.setDataScrollerPresenceGroups(0);

 

Also See:

getEffectiveGroupOffset(), getEffectiveSeriesOffset,
getEffectiveViewableSeries(), ViewableSeries, ScrollOffsetSeries

 

 

getEffectiveViewableSeries()

 

This method can be used to determine whether or not data scrolling is being used in the chart. If this method returns a value greater than zero, it indicates the ViewableSeries property is set to a value greater than zero (i.e., not all series in the data set are imaged). A value of zero indicates the number of imaged series is the same as the number of series in the data set (i.e., ViewableSeries=0).

Syntax:

int getEffectiveViewableSeries();

Input:

None

Return

int: Number of viewable series in the chart.

Example:

perspective1.setDepthRadius(0);
int i = perspective1.getEffectiveViewableSeries();
perspective1.setViewableSeries(i-2);

 

Also See:

getEffectiveGroupOffset(), getEffectiveSeriesOffset,
getEffectiveViewableGroups(), ViewableSeries, ScrollOffsetSeries

 

 

getExceptionalRisers()

 

This method returns the entire hash table of exceptional risers.

Syntax:

java.util.Hashtable getExceptionalRisers();

Input:

None

Return:

Hashtable: Entire hash table of exceptional risers

Also See:

getExceptionalRiser(), setExceptionalRiser(), setNoExceptionalRiser

 

 

getExcludeMaxLabel()

This method can be used to determine whether or not the maximum label is excluded from an axis. If an axis is not identified by id or objectID, the method will return this attribute for the first item in the selection list. You may also use one of the axis-specific properties to determine whether or not the maximum label is excluded from a particular axis (e.g., O1ExcludeMaxLabel, O2ExcludeMaxLabel, X1ExcludeMaxLabel, etc.).

Syntax:

boolean getExcludeMaxLabel();

boolean getExcludeMaxLabel(tdg.draw.IdentObj id);

boolean getExcludeMaxLabel (int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

Return:

boolean: true/false

 

true=

Maximum label is excluded

 

false=

Maximum label is included

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setO1ExcludeMaxLabel(true);
boolean b = perspective1.getExcludeMaxLabel(
    perspective1.getO1Label());
perspective1.setExcludeMinLabel(perspective1.getY1Label(),b);

Also See:

setExcludeMaxLabel(), getExcludeMinLabel(), setExcludeMinLabel(),
O1ExcludeMaxLabel, O2ExcludeMaxLabel, X1ExcludeMaxLabel,
Y1ExcludeMaxLabel, Y2ExcludeMaxLabel.

getExcludeMinLabel()

This method can be used to determine whether or not the minimum label is excluded from an axis in a chart. If an axis is not identified by id or objectID, the method will return this attribute for the first item in the selection list. You may also use one of the axis-specific properties to determine whether or not minimum labels are excluded on an axis (e.g., O1ExcludeMinLabel, O2ExcludeMinLabel, X1ExcludeMinLabel, etc.).

Syntax:

boolean getExcludeMinLabel();

boolean getExcludeMinLabel(tdg.draw.IdentObj id);

boolean getExlcudeMinLabel (int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

Return:

boolean: true/false

 

true=

Minimum label is excluded

 

false=

Minimum label is included

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setO1ExcludeMinLabel(true);
boolean b = perspective1.getExcludeMinLabel(
    perspective1.getO1Label());
perspective1.setExcludeMaxLabel(
    perspective1.getY1Label(),b);

Also See:

setExcludeMinLabel(), getExcludeMaxLabel, setExcludeMaxLabel,
O1ExcludeMinLabel, O2ExcludeMinLabel, X1ExcludeMinLabel,
Y1ExcludeMinLabel, Y2ExcludeMinLabel.

getFillColor()

This method gets the value of a fill color for an area object in a chart.

Syntax:

Color getFillColor (IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

Return:

Color: the value of the fill color for the object identified by id, null = no fill color applied

Also See:

setFillColor(), getBorderColor(), setBorderColor(), getFillType(),
setFillType(), getSelectionFillColor(), getTransparentFillColor(),
setTransparentFillColor(), isSelectionFillColorTransparent(),
setSeriesFillColor()

getFillType()

This method gets the fill type assigned to an area object.

Syntax:

int getFillType (tdg.draw.IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Series())

Return:

int: the fill type of the object identified by id (1...3)

 

1=

Color

 

2=

Gradient

 

3=

Texture

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
int i = perspective1.getFillType(
    perspective1.getSeries(0));
if (i==1)perspective1.setFillColor(
    perspective1.getSeries(0),new Color (255,0,0));

Also See:

setFillType(), getFillColor(), setFillColor(), getGradientDirection(),
setGradientDirection(), getGradientNumPins(), setGradientNumPins(),
getGradientPinLeftColor(), setGradientPinLeftColor(),
getGradientPinPosition(), setGradientPinPosition(),
getGradientPinRightColor(), setGradientPinRightColor(), setTextureURL(),
getTextureDisplayMode(), setTextureDisplayMode()

getFontName()

This method gets the name of the font used for a text object. If an object ID (id or objectID) is not specified, the method returns the font name used for the first item in the selection list.

Syntax:

String getFontName ();

String getFontName(tdg.draw.IdentObj id);

String getFontName(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getFootnote())

objectID: Object Number

Return:

String: font name, null = no font name applied at id or objectID

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableGroups(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setFontName(perspective1.getTitle(),
    "Courier");
perspective1.setFontName(perspective1.getFootnote(),
    perspective1.getFontName(perspective1.getTitle()));
perspective1.setFontName(perspective1.getSubtitle(),
    perspective1.getFontName(perspective1.getTitle()));
perspective1.setFontName(perspective1.getO1Label(),
    perspective1.getFontName(perspective1.getTitle()));
perspective1.setFontName(perspective1.getY1Label(),
    perspective1.getFontName(perspective1.getTitle()));
perspective1.setFontName(perspective1.getLegendText(),
    perspective1.getFontName(perspective1.getTitle()));

Also See:

setFontName(), getFontSizeVC(), setFontSizeVC(), getFontStyle(),
setFontStyle(), setFontSize()

getFontSize()

This methods gets a font size in destination coordinates. It returns an integer value in the range 1...128 (inclusive) identifying the font size. The default is 12.

Syntax:

int getFontSize();

int getFontSize(tdg.draw.IdentObj id);

int getFontSize(int objectID)

Input:

id: IdentObj returned by a getObject() method (e.g., getFootnote())

objectID: Object Number

Return:

int; Font size in destination coordinates (1...128 (inclusive))

getFontSizeVC()

This method gets a font size in virtual coordinates. If an object is not identified with the input parameter id or objectID, this method will return the font size for the first item in the selection list.

Syntax:

int getFontSizeVC ();

int getFontSizeVC(tdg.draw.IdentObj id);

int getFontSizeVC(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getFootnote())

objectID: Object Number

Return:

int: the font size in virtual coordinates.

Example:

perspective1.setAutofit(perspective1.getTitle(),false);
perspective1.setFontSizeVC(perspective1.getTitle(),3400);
perspective1.setAutofit(perspective1.getSubtitle(),false);
perspective1.setFontSizeVC(perspective1.getSubtitle(),
    perspective1.getFontSizeVC(perspective1.getTitle()));
perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableGroups(3);
perspective1.setDataScrollerPresenceGroups(0);

Also See:

setFontSizeVC(), getAutofit(), setAutofit(), getFontName(), setFontName(),
getFontStyle(), setFontStyle(), setFontSize(), FootnoteAutofit,
LegendTextAutofit, O1LabelAutofit, O1TitleAutofit, O2LabelAutofit,
O2TitleAutofit, X1LabelAutofit, X1TitleAutofit, Y1LabelAutofit,
Y1TitleAutofit, Y2LabelAutofit, Y2TitleAutofit

getFontStyle()

This method gets the style of a font that is used for a text object. If an object is not identified by the input parameter id or objectID, the method will return the font style used for the first item in the selection list.

Syntax:

int getFontStyle ();

int getFontStyle(tdg.draw.IdentObj id);

int getFontStyle(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getFootnote())

objectID: Object Number

Return:

int: font style (0...5)

 

0=

Plain

 

1=

Italic

 

2=

Bold

 

3=

Italic/Bold

 

4=

Underline

 

5=

Italic/Underline

Example:

perspective1.setAutofit(perspective1.getTitle(),false);
perspective1.setFontSizeVC(perspective1.getTitle(),3400);
perspective1.setAutofit(perspective1.getSubtitle(),false);
perspective1.setFontSizeVC(perspective1.getSubtitle(),
    perspective1.getFontSizeVC(perspective1.getTitle()));
perspective1.setFontStyle(perspective1.getTitle(),3);
perspective1.setFontStyle(perspective1.getSubtitle(),
    perspective1.getFontStyle(perspective1.getTitle()));
perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);

Also See:

setFontStyle(), getFontSizeVC(), setFontSizeVC(), getFontName(),
setFontName(), setFontSize()

getFrameDepthOffset()

This method gets the depth offset of a chart frame where a DepthAngle has been applied to form a 3D affect (2.5D) on a 2D chart.

Syntax:

Point getFrameDepthOffset ();

Input:

None

Return:

Point = frame depth in 2.5D

Also See:

DepthAngle, DepthRadius

getFrameRect()

This method is useful for objects like axes, that want to draw lines up to but not overlapping the frame rectangle. Different graphs use different frame objects (Bar, Line, Area, pies and circular) the best way to really get the correct frame rectangle is to get it directly from the frame object. This method gets the frame rectangle and translates it to destination coordinates. It makes the rectangle smaller by 1 pixel in each dimension and translates it back to virtual coordinates.

Syntax:

Rectangle getFrameRect ( boolean bInner );

Input:

bInner: true/false

 

true=

Inside edge of frame

 

false=

Outside edge of frame

Return:

Rectangle = size of the frame in virtual coordinates

Example:

perspective1.setDisplay(
    perspective1.getY1AxisLine(),false);
perspective1.setDisplay(
    perspective1.getY1MajorGrid(),false);
perspective1.setDisplay(
    perspective1.getO1MajorGrid(),false);
perspective1.setDisplay(perspective1.getFrame(),false);
perspective1.setLegendRect(
    perspective1.getFrameRect(false));
perspective1.setDataRange(1,1,3,3);
perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableGroups(3);
perspective1.setDataScrollerPresenceGroups(0);

Also See:

getRect(), setRect()

getGradientDirection()

This method gets the direction of a gradient.

Syntax:

int getGradientDirection(IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

Return:

int = gradient direction(1...13)

 

1=

Right

 

2=

Left

 

3=

Down

 

4=

Up

 

5=

Down/Left

 

6=

Up/Left

 

7=

Down/Right

 

8=

Up/Right

 

9=

Radial

 

10=

Radial/Top/Left

 

11=

Radial/Top/Right

 

12=

Radial/Bottom/left

 

13=

Radial/Bottom/Right

Also See:

setGradientDirection(), getFillType(), setFillType(), getGradientNumPins(),
setGradientNumPins(), getGradientPinLeftColor(), setGradientPinLeftColor,
getGradientPinRightColor(), setGradientPinRightColor(),
getGradientPinPosition(), setGradientPinPosition()

getGradientNumPins()

This method gets the number of pins in a gradient.

Syntax:

int getGradientNumPins ( IdentObj id );

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

Return:

int = Number of pins in gradient

Also See:

setGradientNumPins(), getFillType(), setFillType(), getGradientDirection(),
setGradientDirection(), getGradientPinLeftColor(), setGradientPinLeftColor(),
getGradientPinRightColor(), setGradientPinRightColor(),
getGradientPinPosition(), setGradientPinPosition()

getGradientPinLeftColor()

This method gets the color value of the left pin of a gradient.

Syntax:

Color getGradientPinLeftColor (
    IdentObj id,
    int nIndex
);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

nIndex: 0...Number of pins in gradient

Return:

Color: the color value of the left pin in a gradient

Also See:

setGradientPinLeftColor(), getFillType(), setFillType(),
getGradientDirection(), setGradientDirection(), getGradientNumPins(),
setGradientNumPins(), getGradientPinRightColor(),
setGradientPinRightColor(), getGradientPinPosition(),
setGradientPinPosition()

getGradientPinPosition()

This method can be used to determine the pin position of a gradient.

Syntax:

double getGradientPinPosition(
    IdentObj id,
    int nIndex
);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

nIndex: 0...Number of pins in gradient

Return

double = position in the gradient (0.0 to 1.0)

Also See:

setGradientPinPosition(), getFillType(), setFillType(), getGradientDirection(),
setGradientDirection(), getGradientNumPins(), setGradientNumPins(),
getGradientPinRightColor(), setGradientPinRightColor(),
setGradientPinLeftColor()

getGradientPinRightColor()

This method can be used to determine the color value of the right pin of a gradient.

Syntax:

Color getGradientPinRightColor (
    IdentObj id,
    int nIndex
);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

nIndex: 0...Number of pins in gradient

Return:

Color = the color value of the right pin in a gradient

Also See:

setGradientPinRightcolor(), getFillType(), setFillType(),
getGradientDirection(), setGradientDirection(), getGradientNumPins(),
setGradientNumPins(), getGradientPinPosition(), setGradientPinPosition(),
getGradientPinLeftColor(), setGradientPinLeftColor()

getGridCount()

This method can be used to determine the number of minor grid lines on the primary ordinal (O1) axis. You may also use O1MinorGridCount to determine the count of minor grid lines.

Syntax:

int getGridCount ();

int getGridCount(tdg.draw.IdentObj id);

int getGridCount(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1MajorGird())

objectID: Object Number

Return:

int = the number of grid lines for the object specified by id or objectID

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setO1MinorGridDisplay(true);
perspective1.setO1MinorGridStyle(4);
int i = perspective1.getGridCount(
    perspective1.getO1MinorGrid());
perspective1.setGridCount(
    perspective1.getO1MinorGrid(),i*2);
perspective1.setLineWidth(
    perspective1.getO1MinorGrid(),2);

Also See:

setGridCount(), O1MinorGridCount

getGridStep()

This method can be used to determine the number of grid steps assigned to a numeric axis. If an axis object is not identified by id or objectID, the method returns the number of grid steps for the first item in the selection list. You may also use one of the axis-specific properties to determine the number of grid steps assigned on an axis (e.g., X1MajorGridStep, X1MinorGridStep, Y1MajorGridStep, etc.).

Syntax:

double getGridStep();

double getGridStep(tdg.draw.IdentObj id);

double getGridStep(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1MajorGrid())

objectID: Object Number

Return:

double = the number of grid steps on an axis

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
double d = perspective1.getGridStep(
    perspective1.getO1MajorGrid());
perspective1.setGridStep(
    perspective1.getO1MajorGrid(),d*2);
perspective1.setLineWidth(
    perspective1.getO1MajorGrid(),2);

Also See:

setGridStep(), getGridStepAuto(), setGridStepAuto(), X1MajorGridStep,
X1MajorGridStepAuto, X1MinorGridStep, X1MinorGridStepAuto,
Y2MajorGridStep, Y2MajorGridStepAuto, Y2MinorGridStep,
Y2MinorGridStepAuto, Y1MajorGridStep, Y1MajorGridStepAuto,
Y1MinorGridStep, Y1MinorGridStepAuto

getGridStepAuto()

This method returns a boolean that indicates whether or not grid steps are automatically calculated for a numeric axis. You may also use one of the axis-specific properties to determine whether or not grid steps are automatically calculated on a specific axis (e.g., X1MajorGridStepAuto, X1MinorGridStepAuto, etc.).

Syntax:

boolean getGridStepAuto();

boolean getGridStepAuto(tdg.draw.IdentObj id);

boolean getGridStepAuto(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1MajorGrid())

objectID: Object Number

Return:

boolean: true/false

 

true=

Grid steps are automatically calculated

 

false=

Grid steps are not automatically calculated

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
double d = perspective1.getGridStep(
    perspective1.getO1MajorGrid());
boolean b = perspective1.getGridStepAuto(
    perspective1.getO1MajorGrid());
if (b==false) perspective1.setGridStep(
    perspective1.getO1MajorGrid(),d*2);
perspective1.setLineWidth(
    perspective1.getO1MajorGrid(),2);

Also See:

setGridStepAuto(), getGridStep(), setGridStep(), X1MajorGridStepAuto, X1MinorGridStepAuto, Y2MajorGridStepAuto, Y2MinorGridStepAuto, Y1MajorGridStepAuto, Y1MinorGridStepAuto

getGridStyle()

This method can be used to determine the style of grid lines on an axis.

Syntax:

int getGridStyle ( );

int getGridStyle (tdg.draw.IdentObj id );

int getGridStyle ( int objectID );

Input:

id: IdentObj returned by a getObject() method (e.g., getY1MajorGrid())

objectID: Object Number

Return:

int: grid style value 0...5

 

0=

No Grid

 

1=

Normal Grid

 

2=

Grids and Ticks

 

3=

Inner Ticks

 

4=

Outer Ticks

 

5=

Spanned Ticks

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
double d = perspective1.getGridStep(
    perspective1.getO1MajorGrid());
perspective1.setGridStep(
    perspective1.getO1MajorGrid(),d*2);
perspective1.setLineWidth(
    perspective1.getO1MajorGrid(),2);
int i = perspective1.getGridStyle(
    perspective1.getO1MajorGrid());
perspective1.setO1MajorGridStyle(i+1);

Also See:

setGridStyle(), O1MajorGridStyle, O1MinorGridStyle, X1MajorGridStyle, X1MinorGridStyle, Y1MajorGridStyle, Y1MinorGridStyle, Y2MajorGridStyle, Y2MinorGridStyle

getGroupLabel()

This method gets the group label for a specific object ID (id) or group (groupID).

Syntax:

String getGroupLabel();

String getGroupLabel(tdg.draw.IdentObj id);

String getGroupLabel(int groupID);

Input:

id: IdentObj returned by a getObject() method (e.g., getGroup())

groupID = a group number

Return:

String = group label

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setTitleString(
    perspective1.getGroupLabel(0));

Also See:

setGroupLabel, getDataLabel(), setDataLabel(), getSeriesLabel(),
setSeriesLabel()

getID()

This method returns the ID associated with the current event.

Syntax:

int getID()

Input:

None

Return:

int; ID associated with the current event.

Notes:

This method is defined in the TDGEvent class.

Also See:

getDataObject(), addPerspectiveListener(), perspectiveEvent()

getIgnoreSeries()

This method can be used to determine whether or not a particular series is set to be ignored by setIgnoreSeries().

Syntax:

boolean getIgnoreSeries();

boolean getIgnoreSeries (tdg.draw.IdentObj id);

boolean getIgnoreSeries (int seriesID);

Input:

id: the object ID returned by a getObject() method (e.g., getSeries(1))

seriesID: a series number

Return:

boolean: true/false

 

true=

Series is ignored

 

false=

Series is not ignored

Also See:

setIgnoreSeries()

getLabelMargin()

This method can be used to determine the label margins (0 to 100 percent) of a label's width.

Syntax:

int getLabelMargin();

int getLabelMargin (tdg.draw.IdentObj id);

int getLabelMargin (int objectID);

Input:

id: the object ID returned by a getObject() method (e.g., getO1Label())

objectID: an object ID number

Return:

int: Label margin (0...100%)

Also See:

setLabelMargin(), O1LabelMargin

getLabelStagger()

This method can be used to determine whether or not labels are staggered on an axis. You may also use one of the axis-specific properties to determine whether or not labels are staggered on a particular axis (e.g., X1LabelStagger, Y1LabelStagger, Y2LabelStagger, etc.).

Syntax:

boolean getLabelStagger();

boolean getLabelStagger(tdg.draw.IdentObj id);

boolean getLabelStagger(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

objectID: Object Number

Return:

boolean: true/false

 

true=

Labels are staggered

 

false=

Labels are not staggered

Example:

perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableGroups(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setLabelStagger(
    perspective1.getO1Label(),true);
perspective1.setLabelStagger(perspective1.getY1Label(),
    perspective1.getLabelStagger(
    perspective1.getO1Label()));

Also See:

setLabelStagger(), O1LabelStagger, X1LabelStagger, Y1LabelStagger, Y2LabelStagger

getLegendMinWidth()

This method allows a user to resize the legend so that none of the labels wrap or truncate. Note that since it specifically calculates a WIDTH, it is applicable to Vertical legends only! If you try to call this method on a horizontal legend, or before the legend has been created, the method returns zero.

Syntax:

int getLegendMinWidth ();

Input:

None

Return:

int: Minimum legend width. Zero = horizontal legend or legend has not been created

getLegendOrient()

This function returns a value that indicates the orientation of the legend area.

Syntax:

int getLegendOrient();

Input:

None

int: 0/1

 

0=

Vertical

 

1=

Horizontal

Also See:

setLegendOrient()

getLegendRect()

This method can be used to determine the size and location of the legend rectangle.

Syntax:

Rectangle getLegendRect( );

Input:

None

Return:

Rectangle = location/size of legend rectangle

Example:

perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableGroups(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setRect(perspective1.getTitle(),
    perspective1.getLegendRect());
perspective1.setLegendDisplay(false);

Also See:

setLegendRect(), LegendAutomatic, LegendDisplay, LegendMarkerPosition, LegendReverse, LegendTextAutofit

getLineWidth()

This method can be used to determine the thickness (in pixels) of a series line.

Syntax:

int getLineWidth (IdentObj id)

Input:

id: the object ID of a series line

Return:

int: the width of the data line in pixels

Example:

perspective1.setGraphType(41);
perspective1.setY1MajorGridStep(10.0);
perspective1.setLineWidth(perspective1.getSeries(0),10);
perspective1.setLineWidth(perspective1.getSeries(1),
    perspective1.getLineWidth(perspective1.getSeries(0)));
perspective1.setLineWidth(perspective1.getSeries(2),
    perspective1.getLineWidth(perspective1.getSeries(0)));
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableGroups(3);
perspective1.setDataScrollerPresenceGroups(0);

 

Also See:

setLineWidth()

 

 

getLogScale()

This method can be used to determine if logarithmic or linear scale is used on a numeric axis. You may also use one of the axis-specific properties to determine whether logarithmic or linear scale is used on a particular axis (e.g., X1LogScale, Y1LogScale, Y2LogScale, etc.).

Syntax:

boolean getLogScale();

boolean getLogScale(tdg.draw.IdentObj id);

boolean getLogScale(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

Return:

boolean: true/false

 

true=

Logarithmic scale

 

false=

Linear scale

Example:

perspective1.setDataRange(0,0,2,2);
perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setGraphType(21);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setLogScale(perspective1.getY1Axis(),true);
perspective1.setLogScale(perspective1.getY2Axis(),
    perspective1.getLogScale(perspective1.getY1Axis()));

Also See:

setLogScale(), X1LogScale, Y1LogScale, Y2LogScale

getLogScaleBase()

When logarithmic scaling is used on a numeric axis in a chart, this property returns a value that identifies the lowest/base value drawn on

Syntax:

double getLogScaleBase()

double getLogScaleBase(tdg.draw.IdentObj id)

double getLogScaleBase(int objectID)

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

int; An object value

Return:

double; The base value used for logarithmic scaling

Also See:

getLogScale(), setLogScaleBase()

getMarkerShape()

This method can be used to determine the shape of a marker in scatter or line charts. If an object ID (id) or series ID (seriesID) is not specified, the method returns the marker shape (if any) for the first item in the selection list.

Syntax:

int getMarkerShape();

int getMarkerShape(IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

Return:

int: a value 0...32

 

0=

Null

 

1=

Square

 

2=

Circle

 

3=

Diamond

 

4=

Plus

 

5=

Triangle Down

 

6=

Triangle Up

 

7...32

User-defined Java polygon

Example:

perspective1.setGraphType(61);
perspective1.setMarkerSize(perspective1.getSeries(0),90);
perspective1.setMarkerSize(perspective1.getSeries(1),
  perspective1.getMarkerSize(perspective1.getSeries(0)));
perspective1.setMarkerSize(perspective1.getSeries(2),
  perspective1.getMarkerSize(perspective1.getSeries(0)));
perspective1.setMarkerSize(perspective1.getSeries(3),
  perspective1.getMarkerSize(perspective1.getSeries(0)));
perspective1.setMarkerShape(perspective1.getSeries(1),
  perspective1.getMarkerShape(perspective1.getSeries(0)));
perspective1.setMarkerShape(perspective1.getSeries(2),   perspective1.getMarkerShape(perspective1.getSeries(0)));
perspective1.setMarkerShape(perspective1.getSeries(3),   perspective1.getMarkerShape(perspective1.getSeries(0)));

Also See:

getMarkerSize(), setMarkerSize(), getMarkerTemplate(), MarkerDisplay, MarkerSizeDefault

getMarkerSize()

This method can be used to determine the size of a marker in a scatter or line chart. If an object ID (id) or series ID (seriesID) is not specified, the method returns the size of the marker (if any) for the first item in the selection list.

Syntax:

int getMarkerSize();

int getMarkerSize(tdg.draw.IdentObj id);

int getMarkerSize(int seriesID);

int getMarkerSize(int seriesID,int groupID);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

seriesID: series number

groupID: group number

Return:

int: a value (0...100) that represents the size of a marker

Example:

perspective1.setGraphType(61);
perspective1.setMarkerSize(perspective1.getSeries(0),90);
perspective1.setMarkerSize(perspective1.getSeries(1), perspective1.getMarkerSize(perspective1.getSeries(0)));
perspective1.setMarkerSize(perspective1.getSeries(2), perspective1.getMarkerSize(perspective1.getSeries(0)));
perspective1.setMarkerSize(perspective1.getSeries(3), perspective1.getMarkerSize(perspective1.getSeries(0)));
perspective1.setMarkerShape(perspective1.getSeries(0),4);
perspective1.setMarkerShape(perspective1.getSeries(1), perspective1.getMarkerShape(perspective1.getSeries(0)));
perspective1.setMarkerShape(perspective1.getSeries(2), perspective1.getMarkerShape(perspective1.getSeries(0)));
perspective1.setMarkerShape(perspective1.getSeries(3), perspective1.getMarkerShape(perspective1.getSeries(0)));

Also See:

setMarkerSize(), getMarkerShape(), setMarkerShape(), MarkerDisplay, MarkerSizeDefault.

getMarkerTemplate()

This method can be used to determine the marker template that is assigned to an object. The marker template can be assigned to an object or all objects in a chart by the setMarkerShape() method.

Syntax:

MarkerTemplate getMarkerTemplate(IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

Return:

MarkerTemplete: 0...32

 

0=

Null

 

1=

Square

 

2=

Circle

 

3=

Diamond

 

4=

Plus

 

5=

Triangle Down

 

6=

Triangle Up

 

7...32

User-defined Java polygon

Also See:

getMarkerShape(), getNextMarkerTemplateSlot(), setMarkerShape(),
MarkerDisplay, MarkerSizeDefault

getMinimumSize()

This method returns the minimum dimensions (height and width) of a Perspective for Java chart.

Syntax:

java.awt.Dimension getMinimumSize ( );

Input:

None

Return:

Dimension = the minimum size (Height=100, Width=100)

getNextMarkerTemplateSlot()

When registerMarkerTemplate is used to specify user-defined marker shapes, this method can be used to determine the next available slot in the template of defined markers.

Syntax:

int getNextMarkerTemplateSlot()

Input:

None

Return

int: the number (0...32) of the next available marker template slot

Also See:

registerMarkerTemplate()

getNumberFormatCallBack()

This method can be used to determine if a number format callback object has been assigned with the setNumberFormatCallBack() method.

Syntax:

NumberFormatCallBack getNumberFormatCallBack();

Input:

None

Return:

NumberFormatCallBack: Non-Zero = number format callback assigned by setNumberFormatCallBack(), Null = None assigned.

Also See:

isNumberFormatCallBack(), setNumberFormatCallBack()

getNumNonIgnoredSeries()

This method returns an integer values that identifies the number of series in the chart that have not been ignored by setIgnoreSeries().

Syntax:

int getNumNonIgnoredSeries();

Input:

None

Return:

int; Number of series in the chart that have not been set to be ignored by setIgnoreSeries();

Also See:

setIgnoreSeries()

getNumGroups()

This method is used to determine the number of viewable groups in a chart. The number of viewable groups is the number of groups that are visible in a chart after data scrolling and/or zooming. Use getNumTotalGroups() to determine the total number of groups in a chart's data set.

Syntax:

int getNumGroups();

Input:

None

Return:

int = Number of groups in the chart

Example:

perspective1.setViewableGroups(4);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setO1MinorGridCount(
    perspective1.getNumGroups());
perspective1.setO1MinorGridDisplay(true);
perspective1.setO1MajorGridDisplay(false);
perspective1.setDepthRadius(0);
perspective1.setDepthAngle(0);

Also See:

getNumTotalGroups(), getNumSeries(), getNumTotalSeries()

getNumSeries()

This method is used to determine the number of viewable series in a chart. The number of viewable series is the number of series that are visible in a chart after any data scrolling and/or zooming. Use getNumTotalSeries() to determine the total number of series in a chart's data set.

Syntax:

int getNumSeries();

Input:

None

Return:

int = Number of viewable series in the chart

Example:

perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableGroups(4);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setO1MinorGridCount(
    perspective1.getNumSeries());
perspective1.setO1MinorGridDisplay(true);
perspective1.setO1MajorGridDisplay(false);
perspective1.setDepthRadius(0);
perspective1.setDepthAngle(0);

Also See:

getNumGroups(), getNumTotalGroups(), getNumTotalSeries()

getNumTotalGroups()

This function gets the total number of groups in a chart's entire data range. It does not consider any data scrolling or zooming operations that may have been applied to a chart. Use getNumGroups() if you want to get the number of viewable groups in a charts (after any data scrolling or zooming).

Syntax:

int getNumTotalGroups();

Input:

None

Return:

int = the total number of groups in the chart's entire data range

Example:

perspective1.setViewableGroups(4);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setO1MinorGridCount(
    perspective1.getNumTotalGroups());
perspective1.setO1MinorGridDisplay(true);
perspective1.setO1MajorGridDisplay(false);
perspective1.setDepthRadius(0);
perspective1.setDepthAngle(0);

Also See:

getNumGroups(), getNumSeries(), getNumTotalSeries()

getNumTotalSeries()

This function gets the total number of series in a chart's entire data range. It does not consider any data scrolling or zooming operations that may have been applied to a chart. Use getNumSeries() if you want to get the number of viewable series in a charts (after any data scrolling or zooming).

Syntax:

int getNumTotalSeries();

Input:

None

Return:

int = Total number of series in the data set that defines the chart

Example:

perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setViewableGroups(4);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setO1MinorGridCount(
    perspective1.getNumTotalSeries());
perspective1.setO1MinorGridDisplay(true);
perspective1.setO1MajorGridDisplay(false);
perspective1.setDepthRadius(0);
perspective1.setDepthAngle(0);

Also See:

getNumSeries(), getNumGroups(), getNumTotalGroups()

getO1LabelCallback()

If your application uses nested labels on the group axis, this method can be used to determine if a callback method has been assigned with setO1LabelCallBack().

Syntax:

TDGNestedLabel getO1LabelCallBack();

Input:

None

Return:

TDGNestedLabel: Non-Zero = the O1 Label Call Back object assigned with setO1LabelCallBack(), Null = none assigned

Also See:

setO1LabelCallBack, NestedLabels

getPieSliceDelete()

This method can be used to determine whether or not pie slices have been deleted from a pie chart.

Syntax:

boolean getPieSliceDelete();

boolean getPieSliceDelete(tdg.draw.IdentObj id);

boolean getPieSliceDelete(int seriesID);

boolean getPieSliceDelete(int seriesID,int groupID);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

seriesID: series number

groupID: group number

Return:

boolean: true/false

 

true=

Slice deleted

 

false=

Slice not deleted

Example:

perspective1.setGraphType(55);
boolean b = perspective1.getPieSliceDelete (1);
if (b==false)perspective1.setPieSliceDelete(1,true);

Also See:

setPieSliceDelete(), getPieSliceDetach(), setPieSliceDetach()

getPieSliceDetach()

This method can be used to determine the distance a slice is detached from a pie chart.

Syntax:

int getPieSliceDetach();

int getPieSliceDetach(tdg.draw.IdentObj id );

int getPieSliceDetach(int seriesID );

int getPieSliceDetach(int seriesID, int groupID );

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

seriesID: series number

groupID: group number

Return:

int: 0...100 distance slice has been detached from pie chart

Also See:

getPieSliceDelete(), setPieSliceDelete()

getQuadrantLineValueX()

This method gets the scale value where the vertical quadrant line identified by nIndex is located.

Syntax:

double getQuadrantLineValueX(int nIndex)

Input:

nIndex: Quadrant line number (zero to number of quadrant lines drawn)

Return:

double: Scale value. NO_LINEVALUE = automatic scaling is enabled

Example:

perspective1.setGraphType(89);
perspective1.setGridStep(
    perspective1.getX1MajorGrid(),10.0);
perspective1.setGridStep(
    perspective1.getY1MajorGrid(),10.0);
perspective1.setQuadrantLineValueY(0, perspective1.getQuadrantLineValueX(0));

Also See:

getQuadrantLineValueY()

getQuadrantLineValueY()

This method gets the scale value where the horizontal quadrant line identified by nIndex is located.

Syntax:

double getQuadrantLineValueY(int nIndex)

Input:

nIndex: Quadrant line number (zero to number of quadrant lines drawn)

Return:

double: Scale value. NO_LINEVALUE = automatic scaling is enabled

Example:

perspective1.setGraphType(89);
perspective1.setGridStep(
    perspective1.getX1MajorGrid(),10.0);
perspective1.setGridStep(
    perspective1.getY1MajorGrid(),10.0);
perspective1.setQuadrantLineValueX(0, perspective1.getQuadrantLineValueY(0));

Also See:

getQuadrantLineValueX()

getRect()

These methods gets the bounding rectangle for a user-movable object in virtual coordinates (x, y, width, height). See Chapter 3 for a description of the virtual coordinates and a list of user-movable objects.

Syntax:

Rectangle getRect();

Rectangle getRect(tdg.draw.IdentObj id);

Rectangle getRect(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getLegendArea())

objectID: Object Number

Return:

Rectangle = the bounding rectangle for a user-movable object in virtual coordinates (x, y, width, height)

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setLegendOrient(1);
perspective1.setLegendRect(perspective1.getRect(
    perspective1.getFrame()));

Also See:

setRect(), getFrameRect(), getLegendRect(), setLegendRect()

getScaleMax()

This method can be used to determine the maximum scale value assigned to a numeric axis. You may also use one of the axis-specific properties to get the maximum scale on a particular axis (e.g., X1ScaleMax, Y1ScaleMax, Y2ScaleMax, etc.). If an object ID is not specified, the method gets this attribute (if any) for the first item in the selection list.

Syntax:

double getScaleMax();

double getScaleMax(tdg.draw.IdentObj id);

double getScaleMax(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

Return:

double = the maximum value that can be used on the axis identified by id or objectID

Example:

perspective1.setDepthAngle(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(2);
perspective1.setViewableSeries(2);
perspective1.setGraphType(21);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setData(0,0,perspective1.getScaleMax());

Also See:

setScaleMax(), getScaleMaxAuto(), setScaleMaxAuto(), getScaleMin(),
setScaleMin(), getScaleMinAuto(), setScaleMinAuto(), X1ScaleMax,
X1ScaleMaxAuto, Y1ScaleMax, Y1ScaleMaxAuto, Y2ScaleMax,
Y2ScaleMaxAuto

getScaleMaxAuto()

This method can be used to determine if automatic or manual scaling is used on a numeric axis. You may also use one of the axis-specific properties to determine automatic/manual scaling on a particular axis (e.g., X1ScaleMaxAuto, Y1ScaleMaxAuto, etc.).

Syntax:

boolean getScaleMaxAuto();

boolean getScaleMaxAuto(tdg.draw.IdentObj id);

boolean getScaleMaxAuto(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

Return:

boolean: true/false

 

true=

Maximum value is automatically calculated

 

false=

Maximum value is not automatically calculated

Also See:

setScaleMaxAuto(), getScaleMax(), setScaleMax(), getScaleMin(),
setScaleMin(), getScaleMinAuto(), setScaleMinAuto(), X1ScaleMax, X1ScaleMaxAuto, Y1ScaleMax, Y1ScaleMaxAuto, Y2ScaleMax, Y2ScaleMaxAuto

getScaleMin()

This method can be used to determine the minimum scale value assigned to a numeric axis. You may also use one of the axis-specific properties to get the minimum scale on a particular axis (e.g., X1ScaleMin(), Y1ScaleMin(), Y2ScaleMin(), etc.).

Syntax:

double getScaleMin();

double getScaleMin(tdg.draw.IdentObj id);

double getScaleMin(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

Return:

double: the minimum scale value on the axis

Example:

perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(2);
perspective1.setViewableSeries(2);
perspective1.setGraphType(21);
perspective1.setData(0,0,perspective1.getScaleMax());
perspective1.setData(1,1,perspective1.getScaleMin());

Also See:

setScaleMin(), getScaleMax(), setScaleMax(), getScaleMaxAuto(),
setScaleMaxAuto(), getScaleMinAuto(), setScaleMinAuto(), X1ScaleMin, X1ScaleMinAuto, Y1ScaleMin, Y1ScaleMinAuto, Y2ScaleMin, Y2ScaleMinAuto

getScaleMinAuto()

This method can be used to determine if a numeric axis is configured for manual or automatic scaling. You may also use one of the axis-specific properties to determine automatic/manual scaling on a particular axis (e.g., X1ScaleMinAuto(), Y1ScaleMinAuto(), Y2ScaleMinAuto(), etc.)

Syntax:

boolean getScaleMinAuto();

boolean getScaleMinAuto(tdg.draw.IdentObj id);

boolean getScaleMinAuto(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

Return:

boolean: TRUE/FALSE

 

true=

Minimum value is automatically calculated

 

false=

Minimum value is not automatically calculated

Also See:

setScaleMinAuto(), getScaleMax(), setScaleMax(), getScaleMaxAuto(),
setScaleMaxAuto(), getScaleMin(), setScaleMin(), X1ScaleMin, X1ScaleMinAuto, Y1ScaleMin, Y1ScaleMinAuto, Y2ScaleMin, Y2ScaleMinAuto

getScaleMustIncludeZero()

This method can be used to determine whether or not a given axis must include zero. You may also use one of the axis-specific properties to determine if a particular axis must include zero (e.g., X1MustIncludeZero, Y1MustIncludeZero, Y2MustIncludeZero, etc.). If an object ID is not specified, the method gets this attribute (if any) for the first item in the selection list.

Syntax:

boolean getScaleMustIncludeZero();

boolean getScaleMustIncludeZero(tdg.draw.IdentObj id);

boolean getScaleMustIncludeZero(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

Return:

boolean: true/false

 

true=

Axis must include zero

 

false=

Zero not required on this axis

Also See:

setScaleMustIncludeZero(),X1MustIncludeZero, Y1MustIncludeZero, Y2MustIncludeZero

getSelection()

This method returns a Vector of "selection objects" (class SelectionObj). This list represents everything that is selected at the time this method is called.

Syntax:

java.util.Vector getSelection()

Input:

None

Return:

Vector: Selection list

Also See:

getSelectionID()

getSelectionBorderColor()

This method gets the border color of the first item in the selection list.

Syntax:

java.awt.Color getSelectionBorderColor ( );

Input:

None

Return:

Color = the border color of the first item in the selection list.

Also See:

getBorderColor(), setBorderColor(), getTransparentBorderColor(),
setTransparentBorderColor(), isSelectionBorderColorTransparent(),
setSeriesBorderColor()

 

 

getSelectionFillColor()

This method gets the fill color of the first item in the selection list.

Syntax:

java.awt.Color getSelectionFillColor ( );

Input:

None

Return:

Color = the fill color of the first item in the selection list.

Also See:

getFillColor(), setFillColor(), getTransparentFillColor(),
setTransparentFillColor(), isSelectionFillColorTransparent(),
setSeriesFillColor()

 

 

getSelectionLineWidth()

This method returns the width of the first item in the selection list if the item is a line object. If a value of zero is returned, it indicates the first item in the selection list is not a line object.

Syntax:

int getSelectionLineWidth();

Input:

None

Return:

int: A value greater than zero indicates the first item in the selection list is a line object and identifies the width of the line. A value of zero indicates the first item in the selection list is not a line object.

Also See:

getSelectionID(), getSelectionSize(),

getSelectionSize()

This method gets the size of the first item in the selection list.

Syntax:

int getSelectionSize();

Input:

None

Return:

int: size of the first item in the selection list (if any)

Also See:

getSelectionID(), getSelectionBorderColor(), getSelectionFillColor(),
getSelectionLineWidth()

getSelGroup()

This method gets number of the group that is currently selected (if any).

Syntax:

int getSelGroup();

Input:

None

Return:

int = the number of the group that is currently selected

Also See:

getSelSeries()

getSelSeries()

This method gets the number of the series that is currently selected (if any) in a chart.

Syntax:

int getSelSeries();

Input:

None

Return:

int = Number of the series that is currently selected

Example:

void perspective1_mouseClicked(
    java.awt.event.MouseEvent event)
{
    // to do: code goes here.
    int grp;
    int ser;
    String label = "";
    grp = perspective1.getSelGroup();
    ser = perspective1.getSelSeries();
    label = perspective1.getDataAsString(ser,grp);
    perspective1.setGroupLabel(grp, label);
    perspective1.setSeriesLabel(ser,label);
}

Also See:

getSeries(), getSeriesGroup()

 

 

getSeriesBorderColor()

The method returns the border color of a particular series in a chart.

Syntax:

Color getSeriesBorderColor (int s);

Input:

s: a series number

Return:

Color: border color of series

Example:

perspective1.setViewableGroups(2);
perspective1.setViewableSeries(2);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setSeriesBorderColor(0,new Color(0,0,239));
perspective1.setSeriesFillColor(0, perspective1.getSeriesBorderColor(0));

Also See:

getSeriesFillColor(), setSeriesBorderColor()

getSeriesFillColor()

This method can be used to get the fill color of a particular series in a chart.

Syntax:

java.awt.Color getSeriesFillColor (int s);

Input:

s: series number

Return:

Color: fill color value of the specified series

Example:

perspective1.setSeriesFillColor(0, new Color(206,0,121));
perspective1.setSeriesFillColor(2, perspective1.getSeriesFillColor(0));
perspective1.setGraphType(93);

Also See:

getSeriesBorderColor(), setSeriesFillColor()

getSeriesLabel()

This method gets the label string associated with a series in a chart.

Syntax:

java.lang.string getSeriesLabel();

java.lang.string getSeriesLabel(IdentObj id);

java.lang.string getSeriesLabel(int seriesID);

Input:

seriesID: Any valid series number

id: IdentObj returned by a getObject() method (e.g., getSeries())

Return:

String: series label

Example:

perspective1.setViewableGroups(2);
perspective1.setViewableSeries(2);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataScrollerPresenceSeries(0);
perspective1.setTitleString(
    perspective1.getSeriesLabel(0));

Also See:

setSeriesLabel(), getSelSeries()

getSeriesType()

This method gets the series type for a specific object, series number, or the first item in the selection list.

Syntax:

int getSeriesType();

int getSeriesType(tdg.draw.IdentObj id);

int getSeriesType(int seriesID);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

seriesID: series number

Return:

int: the series type (0...3)

 

0=

Riser unspecified

 

1=

Riser bar

 

2=

Riser Marker

 

3=

Riser Area

getShadowColor()

This method gets the color value of a drop shadow.

Syntax:

java.awt.Color getShadowColor(tdg.draw.IdentObj id)

Input:

id: IdentObj returned by a getObject() method

Return:

color: the value of the drop shadow applied to id, null = no drop shadow color applied

Also See:

setShadowColor(), getShadowDisplay(), setShadowDisplay(),
getShadowXOffset(), setShadowXOffset(), getShadowYOffset(),
setShadowYOffset

getShadowDisplay()

This method can be used to determine whether or not a drop shadow is applied to an object in a chart.

Syntax:

boolean getShadowDisplay();

boolean getShadowDisplay(tdg.draw.IdentObj id);

boolean getShadowDisplay(int objectID);

Input:

id: IdentObj returned by a getObject() method

objectID: Object Number

Return:

boolean: true/false

 

true=

Drop shadow is displayed

 

false=

Drop shadow not drawn

Also See:

setShadowDisplay(), getShadowColor(), setShadowColor(),
getShadowXOffset(), setShadowXOffset(), getShadowYOffset(),
setShadowYOffset()

getShadowXOffset()

This method gets the offset in the X-direction of a drop shadow that has been applied to an object.

Syntax:

int getShadowXOffset();

int getShadowXOffset(tdg.draw.IdentObj id);

int getShadowXOffset(int objectID);

Input:

id: IdentObj returned by a getObject() method

objectID: Object Number

Return:

int: X-direction offset of the drop shadow applied to id, null = no drop shadow applied

Also See:

setShadowXOffset(), getShadowColor(), setShadowColor(),
getShadowDisplay(), setShadowDisplay(), getShadowYOffset(),
setShadowYOffset()

getShadowYOffset()

This method gets the offset in the Y-direction of a drop shadow that is assigned to an object.

Syntax:

int getShadowYOffset();

int getShadowYOffset(tdg.draw.IdentObj id);

int getShadowYOffset(int objectID);

Input:

id: IdentObj returned by a getObject() method

objectID: Object Number

Return:

int: Y-direction offset of the drop shadow applied to id, , null = no drop shadow applied

Also See:

setShadowYOffset(), getShadowColor(), setShadowColor(),
getShadowDisplay(), setShadowDisplay(), getShadowXOffset(),
setShadowXOffset()

getSkipBegin()

This method gets the skip begin value. This value represents the first label to be skipped with manual skip mode is enabled.

Syntax:

int getSkipBegin();

int getSkipBegin(tdg.draw.IdentObj id);

int getSkipBegin(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

objectID: Object Number

Return:

int: First label to skip when manual skip mode is enabled with setO1LabelAutoSkip(2)

Also See:

setSkipBegin(), getSkipCount(), setSkipCount(), O1LabelAutoSkip

getSkipCount()

This method gets the skip interval value. This value represents the interval of labels to be skipped with manual skip mode is enabled.

Syntax:

int getSkipCount();

int getSkipCount(tdg.draw.IdentObj id);

int getSkipCount(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

objectID: Object Number

Return:

int: Label skip interval when manual skip mode is enabled with setO1LabelAutoSkip(2)

Also See:

setSkipCount(), getSkipBegin(), O1LabelAutoSkip

getSource()

This method returns the Source where an event originated.

Syntax:

java.lang.Object getSource()

Input:

None

Return:

Object; source associated with the current event.

Notes:

This method is defined in the TDGEvent class.

Also See:

getID(), getDataObject(), addPerspectiveListener(), perspectiveEvent()

getTextFormatPattern()

This method can be used to determine the standard Java number format pattern (if any) assigned to a data text or label object.

Syntax:

String getTextFormatPattern();

string getTextFormatPattern(tdg.draw.IdentObj id);

string getTextFormatPattern(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

Return:

String: A pattern string in the following format:

pattern:= subpattern{;subpattern}
subpattern:= {prefix}integer{.fraction}{suffix}
prefix:= '\\u0000'..'\\uFFFD' - specialCharacters
suffix:= '\\u0000'..'\\uFFFD' - specialCharacters
integer:= '#'* '0'* '0'
fraction:= '0'* '#'*

See Chapter 3 for more detailed information about this format pattern

Also See:

setTextFormatPattern(), getTextFormatPreset(), setTextFormatPreset(),
DataTextFormat, PieFeelerTextFormat, PieRingTotalFormat, X1LabelFormat, Y1LabelFormat, Y2LabelFormat

getTextFormatPreset()

This method can be used to determine the preset format of a text object.

Syntax:

int getTextFormatPreset();

int getTextFormatPreset(tdg.draw.IdentObj id);

int getTextFormatPreset(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

Return:

int: value of text format (-1...17)

 

Value

Format (Example)

 

-1

The pattern defined by setTextFormatPattern is being used.

 

1=

# (Example: 123 = 123)

 

2=

#% (Example: 123 = 12,300%)

 

3=

#.#% (Example: 123 = 12,300.0%)

 

4=

#.##% (Example: 123 = 12,300.00%)

 

5=

$#.## (Example: 123 = $123.00)

 

6=

$# (Example: 123 = $123)

 

7=

#K (Example: 1,234 = 1K)

 

8=

$#K (Example: 1,234 = $1K)

 

9=

#M (Example: 1,234,567 = 1M)

 

10=

$#M (Example: 1,234,567 = $1M)

 

11=

#B (Example: 1,234,567,891 = 1B)

 

12=

$#B (Example: 1,234,567,891 = $1B)

 

13=

#T (Example: 1,234,567,891,234 = 1T)

 

14=

$#T (Example: 1,234,567,891,234 = $1T)

 

15=

show number with thousand separators no decimals (Example: 1,234=1K)

 

16=

show number with thousand separators two decimals (Example: 1,234=1.23K)

 

17=

General currency format for current Locale

Also See:

setTextFormatPreset(), getTextFormatPattern(), setTextFormatPattern(),
DataTextFormat, PieFeelerTextFormat, PieRingTotalFormat, X1LabelFormat, Y1LabelFormat, Y2LabelFormat

getTextJustHoriz()

This method can be used to determine the horizontal alignment of a text object.

Syntax:

int getTextJustHoriz();

int getTextJustHoriz(tdg.draw.IdentObj id);

int getTextJustHoriz(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

Return:

int: 0...2

 

0=

Left

 

1=

Center

 

2=

Right

Also See:

setTextJustHoriz(), getTextJustVert(), setTextJustVert()

getTextJustVert()

This method can be used to determine the vertical alignment of a text object.

Syntax:

int getTextJustVert();

int getTextJustVert(tdg.draw.IdentObj id);

int getTextJustVert(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

Return:

int: 0...2

 

0=

Top

 

1=

Center

 

2=

Bottom

Also See:

setTextJustVert(), getTextJustHoriz(), setTextJustHoriz()

getTextRotation()

This method can be used to determine the rotation angle of a text object.

Syntax:

int getTextRotation();

int getTextRotation(tdg.draw.IdentObj id);

int getTextRotation(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

Return:

int: 0...2

 

0=

None

 

1=

90 Degrees

 

2=

270 Degrees

Also See:

setTextRotation(), O1LabelRotate, O2LabelRotate, X1LabelRotate, Y1LabelRotate, Y2LabelRotate

getTextString()

This method gets the text string assigned to a text object.

Syntax:

string getTextString();

java.lang.string getTextString(tdg.draw.IdentObj id);

java.lang.string getTextString(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getTitle())

objectID: Object Number

Return:

string: string assigned to a text object

Example:

perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setTitleString(perspective1.getTextString(
    perspective1.getFootnote()));

Also See:

setTextString(), FootnoteString, O1TitleString, O2TitleString, SubtitleString, TitleString, X1TitleString, Y1TitleString, Y2TitleString

getTexture()

This method can be used to determine if a texture has been applied to an object in a chart. When a texture name (i.e., a .GIF file name) is supplied as an input parameter, the method identifies whether or not the named texture is applied to any object in the chart. If an Object ID is specified (e.g., getTexture ( getSeries(1);), the method will identify whether or not a texture is applied to the specific object..

Syntax:

Image getTexture ( String szURL );

String getTexture ( IdentObj id );

Input:

szURL: the name of an image to look for in the chart

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

Return:

Image: indicates whether or not the texture exists in the chart. null = texture is not in the look

String: the name of the texture (if any) assigned to id.

Example:

perspective1.setDepthRadius(0);
perspective1.setFillType(perspective1.getSeries(2),3);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(2),0);
perspective1.setTextureURL(perspective1.getSeries(2),
    "file:/C:/PJE/tiles/Azul_Granite.gif");
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setTitleString(
    perspective1.getTexture(perspective1.getSeries(2)));

Also See:

getTextureDisplayMode(), setTextureDisplayMode(), getFillType(),
setFillType(), setTextureURL(), DisplayBarAsPictograph.

getTextureDisplayMode()

This method gets the texture display mode for an object in a chart.

Syntax:

int getTextureDisplayMode(IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

Return:

int: Texture display mode (0/1)

 

0=

Stretched

 

1=

Tiled

Also See:

setFillType(), setTextureURL()

getTextWrap()

This method can be used to determine if line wrapping is enabled for a text object.

Syntax:

boolean getTextWrap();

boolean getTextWrap(tdg.draw.IdentObj id);

boolean getTextWrap(int objectID);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

objectID: Object Number

Return:

boolean: true/false

 

true=

Text wrapping enabled

 

false=

Text wrapping not enabled

Also See:

setTextWrap(), O1LabelWrap, O2LabelWrap

getToolTipCallBack()

This function can be used to determine if a tool tip call back object has been assigned with setToolTipCallBack().

Syntax:

ToolTipCallBack getToolTipCallBack();

Input:

None

Return:

ToolTipCallBack: A tool tip call back object

Also See:

setToolTipCallBack()

getTransparentBorderColor()

This method can be used to determine whether or not a transparent border color is applied to an object.

Syntax:

boolean getTransparentBorderColor ( IdentObj id );

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

objectID: Object Number

Return:

boolean: true/false

 

true=

Transparent border color is applied

 

false=

Transparent border color not applied

Also See:

setTransparentBorderColor(), getBorderColor(), setBorderColor(),
getSelectionBorderColor(), isSelectionBorderColorTransparent(),
setSeriesBorderColor()

getTransparentFillColor()

This method can be used to determine if a transparent fill color is applied to an object.

Syntax:

boolean getTransparentFillColor(IdentObj id);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

Return:

boolean: true/false

 

true=

Transparent fill color is applied

 

false=

Transparent fill color not applied

Also See:

setTransparentFillColor(), getFillColor(), setFillColor(),
getSelectionFillColor(), isSelectionFillColorTransparent(), setSeriesFillColor()

getURL()

This method gets the Universal Resource Locator for any specific Object. This method and the setURL(), getURLTarget, and setURLTarget() methods can be used to include drill-downs in HTML files. They allow any series/group intersection in the chart to be used as a link reference. When the user selects/clicks on an object in a chart where a setURL() is defined, the HTML file provided as an input parameter to the method will automatically be loaded and displayed at the location specified by the setURLTarget().

Syntax:

java.lang.String getURL ();

java.lang.String getURL(tdg.draw.IdentObj id);

java.lang.String getURL(int seriesID);

java.lang.String getURL(int seriesID, int groupID);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

seriesID: Series ID

groupID: Group ID

Return:

String: URL string

Also See:

setURL(), getURLTarget(),setURLTarget(), setDataFileURL()

getURLTarget()

This method gets the frame target for the URL associated with any specific object. It is used in conjunction with getURL() and setURL() to create drill-downs in an HTML file.

Syntax:

java.lang.String getURLTarget();

java.lang.String getURLTarget(tdg.draw.IdentObj id);

java.lang.String getURLTarget(int seriesID);

java.lang.String getURLTarget(int seriesID,int groupID);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

seriesID: Series ID

groupID: Group ID

Return:

String: URL Target string

Also See:

setURLTarget(), getURL(), setURL(), setDataFileURL()

getViewableDataRange()

This method returns a rectangle that represents the current viewable range of data charted in a graph.

Syntax:

DataRange getViewableDataRange();

Input:

None

Return:

Rectangle.x = Starting Row

Rectangle.y = Starting Column

Rectangle.width = Ending Row

Rectangle.height = Ending Column

Also See:

getDataRange(), getViewableDataRangeSG()

getViewableDataRangeSG()

This method returns a rectangle that represents the current viewable range of data charted in a graph in series in groups.

Syntax:

DataRange getViewableDataRangeSG();

Input:

None

Return:

Rectangle.x = Starting Series

Rectangle.y = Starting Group

Rectangle.width = Ending Series

Rectangle.height = Ending Groups

Also See:

getViewableDataRange()

getX1MajorGridStepAutoValue()

When the X1MajorGridStepAuto property is true (enabling automatic calculation of major grid steps on the X1 axis), this method returns a double value that identifies the interval between major grid steps on the X1 axis.

Syntax:

double getX1MajorGridStepAutoValue()

Input:

None

Return:

double; Interval between grid steps on the X1 axis.

Example:

perspective1.setGraphType(61);
double d = perspective1.getX1MajorGridStepAutoValue();
perspective1.setX1MajorGridStepAuto(false);
perspective1.setX1MajorGridStep(d+10);

Also See:

X1MajorGridStepAuto

getX1ScaleMaxAutoValue()

When the X1ScaleMaxAuto property is true (enabling automatic calculation of the maximum scaling value on the X1 axis), this method returns a double that identifies the maximum scale value that will be used on the X1 axis.

Syntax:

double getX1ScaleMaxAutoValue()

Input:

None

Return:

double; Minimum scale value on the X1 axis.

Example:

perspective1.setDepthRadius(0);
perspective1.setGraphType(61);
double d = perspective1.getX1ScaleMaxAutoValue();
perspective1.setX1ScaleMaxAuto(false);
perspective1.setX1ScaleMax(d+100);
double d1 = perspective1.getX1ScaleMinAutoValue();
perspective1.setX1ScaleMinAuto(false);
perspective1.setX1ScaleMin(d1+10);

Also See:

getX1ScaleMinAutoValue(), X1ScaleMaxAuto

getX1ScaleMinAutoValue()

When the X1ScaleMinAuto property is true (enabling automatic calculation of the minimum scaling value on the X1 axis), this method returns a double that identifies the minimum scale value that will be used on the X1 axis.

Syntax:

double getX1ScaleMinAutoValue()

Input:

None

Return:

double; Minimum scale value on the X1 axis.

Example:

perspective1.setDepthRadius(0);
perspective1.setGraphType(61);
double d = perspective1.getX1ScaleMaxAutoValue();
perspective1.setX1ScaleMaxAuto(false);
perspective1.setX1ScaleMax(d+100);
double d1 = perspective1.getX1ScaleMinAutoValue();
perspective1.setX1ScaleMinAuto(false);
perspective1.setX1ScaleMin(d1+10);

Also See:

getX1ScaleMaxAutoValue(), X1ScaleMinAuto

getY1MajorGridStepAutoValue()

When the Y1MajorGridStepAuto property is true (enabling automatic calculation of major grid steps on the Y1 axis), this method returns a double value that identifies the interval between major grid steps on the Y1 axis.

Syntax:

double getY1MajorGridStepAutoValue()

Input:

None

Return:

double; Interval between grid steps on the Y1 axis.

Example:

double d = perspective1.getY1MajorGridStepAutoValue();
perspective1.setY1MajorGridStepAuto(false);
perspective1.setDepthRadius(0);
perspective1.setY1MajorGridStep(d+10);

Also See:

Y1MajorGridStepAuto

getY1ScaleMaxAutoValue()

When the Y1ScaleMaxAuto property is true (enabling automatic calculation of the maximum scaling value on the Y1 axis), this method returns a double that identifies the maximum scale value that will be used on the Y1 axis.

Syntax:

double getY1ScaleMaxAutoValue()

Input:

None

Return:

double; Minimum scale value on the Y1 axis.

Example:

perspective1.setDepthRadius(0);
double d = perspective1.getY1ScaleMaxAutoValue();
perspective1.setY1ScaleMaxAuto(false);
perspective1.setY1ScaleMax(d+100);
double d1 = perspective1.getY1ScaleMinAutoValue();
perspective1.setY1ScaleMinAuto(false);
perspective1.setY1ScaleMin(d1+10);

Also See:

getY1ScaleMinAutoValue(), Y1ScaleMaxAuto

getY1ScaleMinAutoValue()

When the Y1ScaleMinAuto property is true (enabling automatic calculation of the minimum scaling value on the Y1 axis), this method returns a double that identifies the minimum scale value that will be used on the Y1 axis.

Syntax:

double getY1ScaleMinAutoValue()

Input:

None

Return:

double; Minimum scale value on the Y1 axis.

Example:

perspective1.setDepthRadius(0);
double d = perspective1.getY1ScaleMaxAutoValue();
perspective1.setY1ScaleMaxAuto(false);
perspective1.setY1ScaleMax(d+100);
double d1 = perspective1.getY1ScaleMinAutoValue();
perspective1.setY1ScaleMinAuto(false);
perspective1.setY1ScaleMin(d1+10);

Also See:

getY1ScaleMaxAutoValue(), Y1ScaleMinAuto

getY2MajorGridStepAutoValue()

When the Y2MajorGridStepAuto property is true (enabling automatic calculation of major grid steps on the Y2 axis), this method returns a double value that identifies the interval between major grid steps on the Y2 axis.

Syntax:

double getY2MajorGridStepAutoValue()

Input:

None

Return:

double; Interval between grid steps on the Y2 axis.

Example:

perspective1.setGraphType(22);
double d = perspective1.getY2MajorGridStepAutoValue();
perspective1.setY2MajorGridStepAuto(false);
perspective1.setDepthRadius(0);
perspective1.setY2MajorGridStep(d+10);

Also See:

Y2MajorGridStepAuto

getY2ScaleMaxAutoValue()

When the Y2ScaleMaxAuto property is true (enabling automatic calculation of the maximum scaling value on the Y2 axis), this method returns a double that identifies the maximum scale value that will be used on the Y2 axis.

Syntax:

double getY2ScaleMaxAutoValue()

Input:

None

Return:

double; Minimum scale value on the Y2 axis.

Example:

perspective1 = new tdg.Perspective();
perspective1.setDepthRadius(0);
perspective1.setGraphType(22);
double d = perspective1.getY2ScaleMaxAutoValue();
perspective1.setY2ScaleMaxAuto(false);
perspective1.setY2ScaleMax(d+100);
double d1 = perspective1.getY2ScaleMinAutoValue();
perspective1.setY2ScaleMinAuto(false);
perspective1.setY2ScaleMin(d1+10);

Also See:

getY2ScaleMinAutoValue(), Y2ScaleMaxAuto

getY2ScaleMinAutoValue()

When the Y2ScaleMinAuto property is true (enabling automatic calculation of the minimum scaling value on the Y2 axis), this method returns a double that identifies the minimum scale value that will be used on the Y2 axis.

Syntax:

double getY2ScaleMinAutoValue()

Input:

None

Return:

double; Minimum scale value on the X1 axis.

Example:

perspective1 = new tdg.Perspective();
perspective1.setDepthRadius(0);
perspective1.setGraphType(22);
double d = perspective1.getY2ScaleMaxAutoValue();
perspective1.setY2ScaleMaxAuto(false);
perspective1.setY2ScaleMax(d+100);
double d1 = perspective1.getY2ScaleMinAutoValue();
perspective1.setY2ScaleMinAuto(false);
perspective1.setY2ScaleMin(d1+10);

Also See:

getY2ScaleMaxAutoValue(), Y2ScaleMinAuto

getZoomIndex()

This function returns the integer value of the current zoom state. When zooming is enabled with doZoomIn() and doZoomOut(), the current state of zooming is maintained in a zoom list. For example, the initial, un-zoomed state is "state 0". When doZoomIn() is called (through the UI or the API), "state 1" specifies the zoomed-in state. When doZoomIn() is called again, "state 2" is appended to the list. The setZoomIndex() function can be used to change the state back to "state 1" (for example). If doZoomOut() is called, the old "state 2" is eliminated from the list (all states ABOVE the current one are eliminated), and the new zoomed-out state becomes state 2. This method can be used to determine the current zoom state.

Syntax:

int getZoomIndex ();

Input:

None

Return:

int: the index for the current zoom state (0=zooming is not enabled).

Also See:

isValidZoomIndex(), isZoomingArmed(), setZoomIndex()