inputParamString()

This method can be used to load a string of parameters into a chart.

Syntax:

void inputParamString (java.lang.String);

Input:

String = an ASCII string of Perspective for Java properties and methods.

Return:

void;

Also See:

outputParamString()

insertGradientPin()

This method inserts a new color pin in a gradient.

Syntax:

void insertGradientPin (
     tdg.draw.IdentObj id,
     double newPin,
     java.awt.Color leftColor,
     java.awt.Color rightColor
);

Input:

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

newPin: a new gradient pin number

leftColor: the left color value of the new pin

rightColor: the right color value of the new pin

Return:

void;

Also See:

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

isChart3DType()

This method can be used to determine if the GraphType property is set to a 3D graph.

Syntax:

boolean isChart3DType()

Input:

None

Return:

boolean; true/false

 

true=

GraphType is set to one of the 3D charts (0...7, 9, 10, or 12...14)

 

false=

GraphType is not a 3D chart.

Example:

boolean b = perspective1.isChart3DType();
if (b==false)perspective1.setGraphType(0);

Also See:

GraphType, isChartBiPolar(), isChartBLAType(), isChartDualY(), isChartOrientHorz(), isChartPieType(), isChartScatter(), isChartStockType()

isChartBipolar()

This method can be used to determine if the GraphType property is set to one of the bi-polar chart types.

Syntax:

boolean isChartBipolar()

Input:

None

Return:

boolean; true/false

 

true=

GraphType property is set to one of the bi-polar charts

 

false=

GraphType is not a bi-polar chart.

Example:

boolean b = perspective1.isChartBipolar();
if (b==false)perspective1.setGraphType(21);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(4);
perspective1.setViewableSeries(4);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setAxisAssignment(3,1);

Also See:

GraphType, isChart3DType(), isChartBLAType(), isChartDualY(), isChartOrientHorz(), isChartPieType(), isChartScatter(), isChartStockType()

isChartBLAType()

This method can be used to determine if the GraphType property is set to one of the bar, line or area chart types.

Syntax:

boolean isChartBLAType ();

Input:

None

Return:

boolean; true/false

 

true=

GraphType is set to a bar, line, or area chart

 

false=

GraphType is not a bar, line, or area chart.

Example:

boolean b = perspective1.isChartBLAType();
if (b==true)perspective1.setGraphType(21);
perspective1.setDepthRadius(0);
perspective1.setViewableGroups(4);
perspective1.setViewableSeries(4);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setAxisAssignment(3,1);

Also See:

GraphType, isChart3DType(), isChartBiPolar(), isChartDualY(), isChartOrientHorz(), isChartPieType(), isChartScatter(), isChartStockType()

isChartDualY()

This method can be used to determine if the GraphType property is set to one of the Dual-Y chart types.

Syntax:

boolean isChartDualY ();

Input:

None

Return:

boolean; true/false

 

true=

GraphType property is set to one of the dual-axes charts

 

false=

GraphType is not a dual-axes chart

Also See:

GraphType, isChart3DType(), isChartBiPolar(), isChartBLAType(), isChartOrientHorz(), isChartPieType(), isChartScatter(), isChartStockType()

isChartOrientHorz()

This method can be used to determine the orientation of a chart.

Syntax:

boolean isChartOrientHorz ();

Input:

None

Return:

boolean; true/false

 

true=

GraphType property is set to one of the horizontal charts

 

false=

GraphType selects a vertical chart

Also See:

GraphType, isChart3DType(), isChartBiPolar(), isChartBLAType(), isChartDualY(), isChartPieType(), isChartScatter(), isChartStockType()

isChartPieType()

This method can be used to determine if the GraphType property is set to one of the pie charts.

Syntax:

boolean isChartPieType ();

Input:

None

Return:

boolean; true/false

 

true=

GraphType property is set to one of the pie charts

 

false=

GraphType is not a pie chart

Also See:

GraphType, isChart3DType(), isChartBiPolar(), isChartBLAType(), isChartDualY(), isChartOrientHorz(), isChartScatter(), isChartStockType()

isChartScatter()

This method can be used to determine if the GraphType property is set to one of the scatter charts.

Syntax:

boolean isChartScatter ();

Input:

None

Return:

boolean; true/false

 

true=

GraphType property is set to one of the scatter charts

 

false=

GraphType is not a scatter chart

Also See:

GraphType, isChart3DType(), isChartBiPolar(), isChartBLAType(), isChartDualY(), isChartOrientHorz(), isChartPieType(), isChartStockType()

isChartStockType()

This method can be used to determine if the GraphType property is set to one of the stock charts.

Syntax:

boolean isChartStockType ();

Input:

None

Return:

boolean; true/false

 

true=

GraphType property is set to one of the stock charts

 

false=

GraphType is not a stock chart

Also See:

GraphType, isChart3DType(), isChartBiPolar(), isChartBLAType(), isChartDualY(), isChartOrientHorz(), isChartPieType(), isChartScatter()

isColorByGroup()

This method can be used to determine if the chart's color mode is set to color-by-group.

Syntax:

boolean isColorByGroup ();

Input:

None

Return:

boolean; true/false

 

true=

Color mode is set to color-by-group

 

false=

Color-by-group is not selected

Also See:

ColorMode

isColorByHeight()

This method can be used to determine if the ColorByHeight object is present in a chart.

Syntax:

boolean isColorByHeight();

Input:

None

Return:

boolean: true/false

 

true=

ColorByHeight object is used

 

false=

ColorByHeight object is not used

Also See:

getColorByHeight(), ExactColorByHeight

isExceptionalAllowed()

This method can be used to determine if exceptional risers are allowed in a chart. The setNoExceptionalRiser() method enables/disables the user of exceptional risers.

Syntax:

boolean isExceptionalAllowed();

Input:

None

Return:

boolean: true/false

 

true=

Exceptional risers are allowed

 

false=

Exceptional risers are not allowed

Note:

This method is defined in the ObjClassID class.

Also See:

getExceptionalRiser(), getExceptionalRisers(), setExceptionalRiser(), setNoExceptionalRiser()

isGroupScrollerPresent()

This method can be used to determine if the group scroller bar is present in the chart. This object is enabled for display when data scrolling is used with the ScrollOffsetGroup and ViewableGroups properties. The DataScrollerPresenceGroups property determines when or if the group scroller bar is displayed.

Syntax:

boolean isGroupScrollerPresent();

Input:

None

Return:

boolean: true/false

 

true=

group scroller bar is present

 

false=

group scroller bar is not present

Notes:

You can use these methods to get the object ID of the various components of the group scroller bar: getGroupScroller(),
getGroupScrollerEditBox(), getGroupScrollerEditLeft(),
getGroupScrollerEditRight(), getGroupScrollerEditThumb(),
getGroupScrollerThumb()

Also See:

ScrollOffsetGroup, ViewableGroups, DataScrollerPresenceGroups

isNumberFormatCallBack()

This method can be used to determine if a number format callback object has been assigned with the setNumberFormatCallBack() method. It returns true if the number format callback has been registered. Perspective uses it to determine whether to ask the number format callback for formatting, or to do it using the standard (non-custom) formatting.

Syntax:

boolean isNumberFormatCallBack();

Input:

None

Return:

boolean: true/false

 

true=

a valid number format callback object has been assigned with setNumberFormatCallback()

 

false=

a number format callback object has not been assigned.

Also See:

getNumberFormatCallBack(), setNumberFormatCallBack()

isO1AxisPresent()

This method returns true or false indicating whether or not the primary ordinal (O1) axis is present in a chart.

Syntax:

boolean isO1AxisPresent();

Input:

None

Return:

boolean; true / false

 

true=

O1 Axis is present

 

false=

O1 Axis is not present

Also See:

isO2AxisPresent(), isX1AxisPresent(), isY1AxisPresent(), isY2AxisPresent()

isO2AxisPresent()

This method returns true or false indicating whether or not the secondary ordinal (O2) axis is present in a chart. The O2-axis is only present in 3D charts.

Syntax:

boolean isO2AxisPresent( );

Input:

None

Return:

boolean; true / false

 

true=

O2 Axis is present

 

false=

O2 Axis is not present

Also See:

isO1AxisPresent(), isX1AxisPresent(), isY1AxisPresent(), isY2AxisPresent()

isSelection()

This method can be used to determine whether or not there are any items in the selection list.

Syntax:

boolean isSelection ( );

Input:

None

Return:

boolean; true/false

 

true=

there are one or more items in the selection list

 

false=

no items in selection list.

Also See:

isSelectionBorderColorTransparent(), isSelectionCube(),
isSelectionDataLabel(), isSelectionFillColorTransparent(),
isSelectionGridLine(), isSelectionLine(), isSelectionSeriesRelated(),
isSelectionText()

isSelectionBorderColorTransparent()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list has a transparent border color.

Syntax:

boolean isSelectionBorderColorTransparent ();

Input:

None

Return:

boolean; true/false

 

true=

the first item in the selection list is a transparent border color

 

false=

the first item in the selection list is not a transparent border color

Also See:

isSelection(), isSelectionFillColorTransparent()

isSelectionCube()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list is a 3D cube.

Syntax:

boolean isSelectionCube ();

Input:

None

boolean; true/false

 

true=

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

 

false=

the first item in the selection list is not a 3D cube

Also See:

isSelection()

isSelectionDataLabel()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list is a data label object.

Syntax:

boolean isSelectionDataLabel ();

Input:

None

Return:

boolean; true/false

 

true=

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

 

false=

the first item in the selection list is not a data label object

Also See:

isSelection()

isSelectionFillColorTransparent()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list is a transparent fill color.

Syntax:

boolean isSelectionFillColorTransparent ();

Input:

None

Return:

boolean; true/false

 

true=

the first item in the selection list is a transparent fill color

 

false=

the first item in the selection list is not a transparent fill color

Also See:

isSelection(), isSelectionBorderColorTransparent()

isSelectionGridLine()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list is a grid line object.

Syntax:

boolean isSelectionGridLine ();

Input:

None

Return:

boolean; true/false

 

true=

the first item in the selection list is a grid line object

 

false=

the first item in the selection list is not a grid line object

Also See:

isSelection()

isSelectionLegend()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list is the legend area.

Syntax:

boolean isSelectionLegend ();

Input:

None

Return:

boolean; true/false

 

true=

the first item in the selection list is the legend area

 

false=

the first item in the selection list is not the legend area

Also See:

isSelection()

isSelectionLine()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list is a line object.

Syntax:

boolean isSelectionLine ();

Input:

None

Return:

boolean; true/false

 

true=

the first item in the selection list is a line object

 

false=

the first item in the selection list is not a line object

Also See:

isSelection()

isSelectionRiser()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list is a riser object.

Syntax:

boolean isSelectionRiser ();

Input:

None

Return:

boolean; true/false

 

true=

the first item in the selection list is a riser object

 

false=

the first item in the selection list is not a riser object

Also See:

isSelection()

isSelectionSeriesRelated()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list is associated with a series.

Syntax:

boolean isSelectionSeriesRelated ();

Input:

None

Return:

boolean; true/false

 

true=

first item in selection is series related

 

false=

item is not associated with a series.

Also See:

isSelection()

isSelectionText()

If isSelection() returns true, this method can be used to determine whether or not the first item in the selection list is a text object (i.e., an object with valid font properties).

Syntax:

boolean isSelectionText ();

Input:

None

Return:

boolean; true/false

 

true=

the first item in the selection list is a text object

 

false=

the first item in the selection list is not a text object

Example:

 

Also See:

isSelection(), setTextFormatPattern(), setTextFormatPreset,
setTextJustHoriz(), setTextJustVert(), setTextRotation(), setTextString(),
setFontName(), setFontSizeVC(), setFontStyle(), TextAutofitMax,
TextAutofitMin

isSeriesScrollerPresent()

This method can be used to determine if the series scroller bar is present in the chart. This object is enabled for display when data scrolling is used with the ScrollOffsetSeries and ViewableSeries properties. The DataScrollerPresenceSeries property determines when or if the series scroller bar is displayed.

Syntax:

boolean isSeriesScrollerPresent();

Input:

None

Return:

boolean: true/false

 

true=

series scroller bar is present

 

false=

series scroller bar is not present

Notes:

You can use these methods to get the object ID of the various components of the group scroller bar: getSeriesScroller(), getSeriesScrollerEditBox(), getSeriesScrollerEditLeft(), getSeriesScrollerEditRight(), getSeriesScrollerEditThumb(), getSeriesScrollerThumb()

Also See:

ScrollOffsetSeries, ViewableSeries, DataScrollerPresenceSeries

isSQLTypeNumeric()

This method can be used to determine whether or not an SQL data type is numeric.

Syntax:

boolean isSQLTypeNumeric (int sqlType);

Input:

sqlType: an SQL data type

Return:

boolean; true/false

 

true=

sqlType is one of case TINYINT, SMALLINT, INTEGER, FLOAT, REAL, DOUBLE, NUMERIC, DECIMAL

 

false=

sqlType is not a numeric data type

Also See:

isSQLTypeString()

isSQLTypeString()

This method can be used to determine whether or not an SQL data type is a string.

Syntax:

boolean isSQLTypeString (int sqlType);

Input:

sqlType: an SQL data type

Return:

boolean: true/false

 

true=

sqlType is one of: CHAR, VARCHAR, or LONGVARCHAR.

 

false=

sqlType is not a string

Also See:

isSQLTypeNumeric()

isToolTipCallBack()

This method can be used to determine if a tool tip callback object has been assigned with the setToolTipCallBack() method. It returns true if the tool tip callback has been registered. Perspective uses it to determine whether to ask the number tool tip callback for formatting, or to do it using the standard (non-custom) formatting.

Syntax:

boolean isToolTipCallBack();

Input:

None

Return:

boolean: true/false

 

true=

a tool tip call back object has been assigned

 

false=

a tool tip call back is not present

Also See:

getToolTipCallBack(), setToolTipCallBack()

isValidZoomIndex()

This method returns a boolean value indicating whether or not the zoom index identified by the input parameter, index, is valid. Use getZoomIndex() to get the current zoom index.

Syntax:

boolean isValidZoomIndex(int index);

Input:

index: a zoom index number

Return:

boolean: true/false

 

true=

index is valid

 

false=

index is not valid

Also See:

getZoomIndex()

isX1AxisPresent()

This method returns true or false indicating whether or not the X1- axis is present in a chart.

Syntax:

boolean isX1AxisPresent( );

Input:

None

Return:

boolean; true / false

 

true=

X1 Axis is present

 

false=

X1 Axis is not present

Also See:

isO1AxisPresent(), isO2AxisPresent(), isY1AxisPresent(), isY2AxisPresent()

isY1AxisPresent()

This method returns true or false indicating whether or not the primary numeric (Y1) axis is present in a chart.

Syntax:

boolean isY1AxisPresent( );

Input:

None

Return:

boolean; true / false

 

true=

Y1 Axis is present

 

false=

Y1 Axis is not present

Also See:

isO1AxisPresent(), isO2AxisPresent(), isX1AxisPresent(), isY2AxisPresent()

isY2AxisPresent()

This method returns true or false indicating whether or not the secondary numeric (Y2) axis is present in a chart. The Y2-axis is only present in dual axis charts.

Syntax:

boolean isY2AxisPresent( );

Input:

None

Return:

boolean; true / false

 

true=

Y2 Axis is present

 

false=

Y2 Axis is not present

Also See:

isO1AxisPresent(), isO2AxisPresent(), isX1AxisPresent(), isY1AxisPresent()

isZ1AxisPresent()

This method returns true or false indicating whether or not the Z-axis is present in a chart.

Syntax:

boolean isZ1AxisPresent( );

Input:

None

Return:

boolean; true / false

 

true=

Z1 Axis is present

 

false=

Z1 Axis is not present

Also See:

isO1AxisPresent(), isO2AxisPresent(), isX1AxisPresent(), isY1AxisPresent(), isY2AxisPresent()

isZoomingArmed()

This method returns a boolean value indicating whether or not data zooming has been enabled by a doZoomIn() or doZoomOut().

Syntax:

boolean isZoomingArmed();

Input:

None

Return:

boolean; true/false

 

true=

Zooming is enabled and graph has been zoomed in or out

 

false=

Zooming is not enabled

Also See:

doZoomIn(), doZoomOut()