Object ID Methods

About Using Object ID Methods

All of the methods in the chapter return the object ID (IdentObj) of a chart object. This value is suitable for use with any other method that requires an IdentObj as input (e.g., setFillColor (getChartBackground(), new Color (255, 255, 0));). Most of these methods do not require an input parameter.

getAreaRiser()

This method returns the object ID of the risers in an area chart. You may specify a series and group number to select a particular area riser.

SYNTAX:

IdentObj getAreaRiser();
IdentObj getAreaRiser (int s, int g)

INPUT:

s/g: optional series and group number

EXAMPLE:

setGraphType (31);
setDataValue (getAreaRiser (1, 1), 60);
setDataValue (getAreaRiser (1, 2), 65);

getAreaRiserBottom/Top()

These methods return the object IDs of the bottom and top of an area riser.

SYNTAX:

IdentObj getAreaRiserBottom();
IdentObj getAreaRiserTop();

getBarRiser()

This method returns the object ID riser in a bar chart. You may specify a series and group number to select a particular bar riser.

SYNTAX:

IdentObj getBarRiser();
IdentObj getBarRiser (int s, int g);

INPUT:

s, g: optional series & group number

EXAMPLE:

setDataValue (getBarRiser (1, 1), 60);
setDataValue (getBarRiser (1, 2), 65);

getBarRiserBottom/Side()

These methods return the object IDs of the bottom and side of a bar riser.

SYNTAX:

IdentObj getBarRiserBottom();
IdentObj getBarRiserSide();

getBeveledLegend()

This method returns the object ID of the beveled legend area pseudo object.

SYNTAX:

IdentObj BeveledLegend();

getBeveledLegendMarker()

This method returns the object ID of the beveled legend markers pseudo object.

SYNTAX:

IdentObj BeveledLegendMarker();

getBeveledRiser()

This method returns the object ID of the beveled risers pseudo object.

SYNTAX:

IdentObj BeveledRiser();

EXAMPLE:

setDepthRadius(0);
 setGraphType(18);
 setDisplay(getBeveledLegend(), true);
 setDisplay(getBeveledLegendMarker(), true);
 setDisplay(getBeveledRiser(), true);

getChartBackground()

This method returns the object ID of the background area of the graph.

SYNTAX:

IdentObj getChartBackground();

EXAMPLE:

setFillColor (getChartBackground(), new Color (255, 255, 0));

getChildLinkLine()

This method returns the object ID of the link line from one parent to a child task in a Gantt chart.

SYNTAX:

IdentObj getChildLinkLine();

EXAMPLE:

// Draw Child Link Lines in Red
setBorderColor (getChildLinkLine(), new Color (255, 0, 0));

getColorByHeight()

When a chart is colored by height (rather than by series or by group), the charting engine chooses the color of quantative data representations based on the data values supplied to the chart. This happens in spectral map charts and in 3D surface charts. If, for example, the data ranges from 7 to 74 and the Y1 axis scale, therefore, goes from 0 to 80, the charting engine might have the color blue assigned to zero, red assigned to 80, and various interpolated shades for values between zero and 80. Note that Spectral Map charts do include a Y1 axis even though it is not visible in the chart. The getColorByHeight() method returns the object ID of the "color by height gradient" (in this case a blue to red one). With the object ID, your application can modify the gradient. Its end colors can be changed or the gradient could be made more complex. For example, in a spectral map of some topography, you could specify that the first half of the gradient representing ocean depths from -20000 feet to zero go from dark blue to light blue. The second half of the gradient might show land heights from zero to 20000 feet and could be represented by a gradient from green to brown.

SYNTAX:

IdentObj getColorByHeight();

EXAMPLE:

setGraphType (12);
setGradientNumPins (getColorByHeight(), 4);
setGradientPinLeftColor (getColorByHeight(), new Color (255, 0, 0), 1);
setGradientPinPosition (getColorByHeight(), 0.0, 0);
setGradientPinPosition (getColorByHeight(), 1.0, 1);
setGradientPinRightColor (getColorByHeight(), new Color (0, 0, 255), 0);

getCubeFloor()

This method returns the object ID of the cube floor in a 3D chart.

SYNTAX:

IdentObj getCubeFloor();

EXAMPLE:

setGraphType (14);
setDisplay (getCubeFloor(), false);

getCubeFloorGridX()

This method returns the object ID of X-axis grid lines that may be displayed on the cube floor in a 3D graph.

SYNTAX:

IdentObj getCubeFloorGridX();

EXAMPLE:

setGraphType (4);
setDisplay (getCubeFloorGridX(), true);

getCubeFloorGridZ()

This method returns the object ID of Z-axis grid lines that may be displayed on the cube floor in a 3D graph.

SYNTAX:

IdentObj getCubeFloorGridZ();

EXAMPLE:

setGraphType (4);
setDisplay (getCubeFloorGridZ(), true);

getCubeLeftWall()

This method returns the object ID of the left wall of the cube in a 3D graph.

SYNTAX:

IdentObj getCubeLeftWall();

EXAMPLE:

setGraphType (4);
setDisplay (getCubeLeftWall(), false);

getCubeLeftWallGridY()

This method returns the object ID of Y-axis grid lines that may be displayed on the cube left wall in a 3D graph.

SYNTAX:

IdentObj getCubeLeftWallGridY();

EXAMPLE:

setGraphType (4);
setDisplay (getCubeLeftWallGridY(), true);

getCubeLeftWallGridZ()

This method returns the object ID of Z-axis grid lines that may be displayed on the cube left wall in a 3D graph.

SYNTAX:

IdentObj getCubeLeftWallGridZ();

EXAMPLE:

setGraphType (4);
setDisplay (getCubeLeftWallGridZ(), true);

getCubeRightWall()

This method returns the object ID of the right wall of the cube in a 3D graph.

SYNTAX:

IdentObj getCubeRightWall();

EXAMPLE:

setGraphType (4);
setDisplay (getCubeRightWall(), false);

getCubeRightWallGridX()

This method returns the object ID of X-axis grid lines that may be displayed on the cube right wall in a 3D graph.

SYNTAX:

IdentObj getCubeRightWallGridX();

EXAMPLE:

setGraphType (4);
setDisplay (getCubeRightWallGridX(), true);

getCubeRightWallGridY()

This method returns the object ID of Y-axis grid lines that may be displayed on the cube right wall in a 3D graph.

SYNTAX:

IdentObj getCubeRightWallGridY();

EXAMPLE:

setGraphType (4);
setDisplay (getCubeRightWallGridY(), true);

getCubeRiserFace()

This method returns the object ID of the face of risers in a 3D graph.

SYNTAX:

IdentObj getCubeRiserFace();

getCubeRiserGridX()

This method returns the object ID of X-axis grid lines on risers in a 3D graph.

SYNTAX:

IdentObj getCubeRiserGridX();

EXAMPLE:

setGraphType (12);
setDisplay (getCubeRiserGridX(), true);

getCubeRiserGridY()

This method returns the object ID of Y-axis grid lines on risers in a 3D graph.

SYNTAX:

IdentObj getCubeRiserGridY();

EXAMPLE:

setGraphType (1);
setDisplay (getCubeRiserGridY(), true);

getCubeRiserGridZ()

This method returns the object ID of Z-axis grid lines on risers in a 3D graph.

SYNTAX:

IdentObj getCubeRiserGridZ();

EXAMPLE:

setGraphType (12);
setDisplay (getCubeRiserGridZ(), true);

getCurrentDateGrid()

This method returns the object ID the current date grid in a Gantt chart.

SYNTAX:

IdentObj getCurrentDateGrid()

EXAMPLE:

setGraphType (99);
setFillColor (getCurrentDateGrid(), new Color (255, 0, 0));

getCurrentDateLabel()

This method returns the object ID of the current date label in a Gantt chart.

SYNTAX:

IdentObj getCurrentDateLabel()

EXAMPLE:

setGraphType (99);
setFillColor (getCurrentDateLabel(), new Color (255, 0, 0));
setFontSize (getCurrentDateLabel(), 6);

getCurveFitCorrelationText()

The method returns the object ID of the curve fit correlation text. A curve fit line is drawn with the setCurveFitType() method.

SYNTAX:

IdentObj getCurveFitCorrelationText()

getCurveFitCorrelationTextBox()

This method returns the object ID of the text box behind the curve fit correlation text.

SYNTAX:

IdentObj getCurveFitCorrelationText()

getCurveFitEquationText()

The method returns the object ID of the curve fit equation text. A curve fit line is drawn with the setCurveFitType() method. The CurveFitEquationDisplay property can be used to show/hide the equation text.

SYNTAX:

IdentObj getCurveFitEquationText()
IdentObj getCurveFitEquationText (int s)

INPUT:

s; an optional series number

EXAMPLE:

setCurveFitType (1, 11);
setFontStyle (getCurveFitEquationText(), 3);
setFillColor (getCurveFitEquationText(), new Color (0, 255, 0));

getCurveFitEquationTextBox()

The method returns the object ID of the text box that surrounds the equation text when a curve fit line is shown with the setCurveFitType() method.

SYNTAX:

IdentObj getCurveFitEquationTextBox()

getCurveFitLineRiser()

The method returns the object ID of the curve fit line that is drawn by the setCurveFitType() method.

SYNTAX:

IdentObj getCurveFitLineRiser()
IdentObj getCurveFitLineRiser (int s)

INPUT:

s; an optional series number

EXAMPLE:

setCurveFitType (1, 11);
setFontStyle (getCurveFitEquationText(), 3);
setFillColor (getCurveFitEquationText(), new Color (0, 0, 255));
setBorderColor (getCurveFitLineRiser (1), new Color (255, 0, 0));

getDataText()

This method returns the object ID of a chart's data text.

SYNTAX:

IdentObj getDataText();
IdentObj getDataText (int s, int g);

INPUT:

s/g: series and group number

EXAMPLE:

setDisplay (getDataText(), true);

getDateScaleGrid()

The method returns the object ID of the date grid in a Gantt chart.

SYNTAX:

IdentObj getDateScaleGrid()

EXAMPLE:

// Make the Date Grid Red
setLineColor (getDateScaleGrid(), new Color (255, 0, 0));

getDateScaleLabel()

The method returns the object ID of date scale labels that are drawn at the top of a Gantt chart. Note that date scale labels are only drawn if the DateScale property is set to DATESCALE_DAYS (1).

SYNTAX:

IdentObj getDateScaleLabel()

EXAMPLE:

// Make Date Scale Labels Red
setFillColor (getDateScaleLabel(), new Color (255, 0, 0));

getExceptionalRiser()

This method returns the object ID of an exceptional riser at series (s) and group (g). Note that s and g are ABSOLUTE series and group (not relative to the current viewable data range).

SYNTAX:

IdentObj getExceptionalRiser (int s, int g);

INPUT:

s, g: optional series & group number

EXAMPLE:

setExceptionalRiser (2, 1);
setDataValue (getExceptionalRiser (2, 1), 70);

getFootnote()

This method returns the object ID of the chart footnote object.

SYNTAX:

IdentObj getFootnote();

EXAMPLE:

setFontName (getFootnote(), "TimesRoman");
setFontSizeVC (getFootnote(), 2318);

getFootnoteBox()

This method returns the object ID of the box that surrounds the chart footnote.

SYNTAX:

IdentObj getFootnoteBox()

EXAMPLE:

setDisplay (getFootnoteBox(), true);
setFillColor (getFootnoteBox(), new Color (255, 0, 0));

getFrame()

This method returns the object ID of the chart frame.

SYNTAX:

IdentObj getFrame();

EXAMPLE:

setDisplay (getY1AxisLine(), false);
setDisplay (getY1MajorGrid(), false);
setDisplay (getO1MajorGrid(), false);
setDisplay (getFrame(), false);

getFrameBottom()

This method returns the object ID of the bottom of the chart frame.

SYNTAX:

IdentObj getFrameBottom();

getFrameSeparator()

This method returns the object ID of the line that separates the two halves of the chart frame in a dual-axis chart.

SYNTAX:

IdentObj getFrameSeparator();

EXAMPLE:

setGraphType (21);
setLineWidth (getFrameSeparator(), 8);

getFrameSide()

This method returns the object ID of the chart frame side.

SYNTAX:

IdentObj getFrameSide();

getFunnelCrust()

This method returns the object ID of the crust of a funnel chart (GraphType 106).

SYNTAX:

IdentObj getFunnelCrust()

EXAMPLE:

setGraphType (106);
setFillColor (getFunnelCrust(), new Color (255, 0, 0));

getFunnelFeeler()

This method returns the object ID feelers in a funnel chart (GraphType 106).

SYNTAX:

IdentObj getFunnelFeeler()

EXAMPLE:

setGraphType (106);
setLineWidth (getFunnelFeeler(), 3);
setBorderColor (getFunnelFeeler(), new Color (255, 0, 0));

getFunnelLabel()

This method returns the object ID of labels in a funnel chart (GraphType 106).

SYNTAX:

IdentObj getFunnelLabel()

EXAMPLE:

setGraphType (106);
setFillColor (getFunnelLabel(), new Color (255, 0, 0));

getFunnelValueLabel()

This method returns the object ID of value labels in a funnel chart (GraphType 106).

SYNTAX:

IdentObj getFunnelValueLabel()

EXAMPLE:

setGraphType (106);
setFillColor (getFunnelValueLabel(), new Color (255, 0, 0));
setFontStyle (getFunnelValueLabel(), 2);

getGaugeArea()

This method returns the object ID of the gauge area.

SYNTAX:

IdentObj getGaugeArea()

getGaugeBackground()

This method returns the object ID of the background in a gauge chart.

SYNTAX:

IdentObj getGaugeBackground()

EXAMPLE:

setDisplay (getFrame(), false);
setFillColor (getGaugeBackground(), new Color (255, 255, 0));

getGaugeBand1...5()

These methods return the object ID of the segments of the band in a guage chart.

SYNTAX:

IdentObj getGaugeBand1()
IdentObj getGaugeBand2()
IdentObj getGaugeBand3()
IdentObj getGaugeBand4()
IdentObj getGaugeBand5()

EXAMPLE:

setBorderColor (getGaugeBand1(), new Color (255, 255, 255));
setBorderColor (getGaugeBand2(), new Color (0, 0, 0));
setBorderColor (getGaugeBand3(), new Color (0, 0, 255));
setBorderColor (getGaugeBand4(), new Color (255, 0, 0));
setBorderColor (getGaugeBand5(), new Color (255, 255, 255));

getGaugeBand1...5Label()

These methods return the object ID of the labels that may be displayed next to the segments of the band in a guage chart.

SYNTAX:

IdentObj getGaugeBand1Label()
IdentObj getGaugeBand2Label()
IdentObj getGaugeBand3Label()
IdentObj getGaugeBand4Label()
IdentObj getGaugeBand5Label()

getGaugeGlass()

This method returns the object ID of the glass in a guage chart.

SYNTAX:

IdentObj getGaugeGlass()

getGaugeLabel()

This method returns the object ID of the numeric value labels in a guage chart.

SYNTAX:

IdentObj getGaugeLabel()

EXAMPLE:

setFillColor (getGaugeLabel(), new Color (255, 0, 0));
setFontStyle (getGaugeLabel(), 2);

getGaugeMajorTick()

This method returns the object ID of the major tick marks in a guage chart.

SYNTAX:

IdentObj getGaugeMajorTick()

EXAMPLE:

setBorderColor (getGaugeMinorTick(), new Color (0, 0, 255));
setBorderColor (getGaugeMajorTick(), new Color (255, 0, 0));

getGaugeMinorTick()

This method returns the object ID of the minor tick marks in a guage chart.

SYNTAX:

IdentObj getGaugeMinorTick()

EXAMPLE:

See getGaugeMajorTick()

getGaugeNeedle()

This method returns the object ID of the needle in a guage chart.

SYNTAX:

IdentObj getGaugeNeedle()

EXAMPLE:

setFillColor (getGaugeNeedle(), new Color (255, 0, 0));

getGaugeScaleArea()

This method returns the object ID of the scale area in a guage chart.

SYNTAX:

IdentObj getGaugeScaleArea()

getGaugeTitle()

This method returns the object ID of the title in a guage chart.

SYNTAX:

IdentObj getGaugeTitle()

EXAMPLE:

setFillColor (getGaugeTitle(), new Color (255, 0, 0));
setFontStyle (getGaugeTitle(), 2);

getGroup()

This method returns the object ID of group number nGroup.

SYNTAX:

IdentObj getGroup (int nGroup);

INPUT:

nGroup: Any valid group number.

EXAMPLE:

setGroupLabel (getGroup (0), "NEW");

getGroupScroller()

This method returns the object ID of the group data scrolling bar that can be enabled and displayed with the DataScrollerPresenceGroups property.

SYNTAX:

IdentObj getGroupScroller();

EXAMPLE:

setRect (getGroupScroller(), new Rectangle (-12351, -9382, 15852, 2927));

getGroupScrollerEditBox()

This method returns the object ID of the group scroller edit box. The group scroller bar is enable and displayed with the DataScrollerPresenceGroups property. The edit box is the editable area of the scroller bar that shows three numbers representing the total groups, viewable groups, and group offset.

SYNTAX:

IdentObj getGroupScrollerEditBox()

EXAMPLE:

setFillColor (getGroupScrollerEditBox(), new Color (206, 0, 121));

getGroupScrollerEditLeft()

This method returns the object ID of the group data scrolling left edit bar that can be enabled and displayed with the DataScrollerPresenceGroups property. This object is the left most number in the editable area of the scroller bar that shows three numbers representing the total groups, viewable groups, and group offset.

SYNTAX:

IdentObj getGroupScrollerEditLeft();

getGroupScrollerEditRight()

This method returns the object ID of the group data scrolling right edit bar that can be enabled and displayed with the DataScrollerPresenceGroups property. This object is the right most number in the editable area of the scroller bar that shows three numbers representing the total groups, viewable groups, and group offset.

SYNTAX:

IdentObj getGroupScrollerEditRight();

getGroupScrollerEditThumb()

This method returns the object ID of the group data scrolling bar edit thumb that can be enabled and displayed with the DataScrollerPresenceGroups property. The edit thumb is the center number in the editable area of the scroll bar that shows three numbers representing the total groups, viewable groups, and group offset.

SYNTAX:

IdentObj getGroupScrollerEditThumb();

EXAMPLE:

See getGroupScroller()

getGroupScrollerThumb()

This method returns the object ID of the group scroller edit box. The group scroller bar is enabled and displayed with DataScrollerPresenceGroups. The thumb is the movable area of the scroller bar that can be used to adjust the group offset.

SYNTAX:

IdentObj getGroupScrollerThumb();

EXAMPLE:

setFillColor (getGroupScrollerThumb(), new Color (206, 0, 121));

getHistogramRiser()

This method returns the object ID of the risers in a histrogram chart.

SYNTAX:

IdentObj getHistogramRiser();

EXAMPLE:

setFillColor (getHistogramRiser(),  new Color (0, 174, 227));
setGraphType (85);

getLegendArea()

This method returns the object ID of the chart's legend area.

SYNTAX:

IdentObj getLegendArea();

EXAMPLE:

setDisplay (getLegendArea(), false);

getLegendMarker()

This method returns the object ID of markers in the chart's legend area. Use the input parameter (s) to select the legend marker for a particular series.

SYNTAX:

IdentObj getLegendMarker();
IdentObj getLegendMarker (int s);

INPUT:

s: a series number

getLegendScroller()

This method returns the object ID of the scroller bar in the legend area. The legend scroll bar must be enabled with the LegendScroll property.

SYNTAX:

IdentObj getLegendScroller()

EXAMPLE:

setBorderColor (getLegendScroller(), new Color (255, 0, 0));

getLegendScrollerThumb()

This method returns the object ID of the legend scroll bar thumb. The legend scroll bar must be enabled with the LegendScroll property.

SYNTAX:

IdentObj getLegendScrollerThumb()

EXAMPLE:

setBorderColor (getLegendScroller(), new Color (255, 0, 0));
setFillColor (getLegendScrollerThumb(), new Color (0, 255, 0));

getLegendText()

This method returns the object ID of text in the chart's legend text.

SYNTAX:

IdentObj getLegendText();
IdentObj getLegendText (int s);

INPUT:

s: a series number

EXAMPLE:

setFontStyle (getLegendText(), 6);

getLegendTextBox()

This method returns the object ID of the textbox behind the chart's legend text.

SYNTAX:

IdentObj getLegendTextBox()

getLineMarker()

This method returns the object ID of markers in a line chart. Use the optional series number (s) parameter to select a particular series of markers in a line chart.

SYNTAX:

IdentObj getLineMarker();
IdentObj getLineMarker (int s, int g);

INPUT:

s, g: optional series and group number

EXAMPLE:

setGraphType (41);
setMarkerShape (getLineMarker (1, 3), 4);

getLineRiser()

This method returns the object ID of risers in a line chart. Use the optional series number (s) parameter to get the object ID is a riser for a particular series in a line chart.

SYNTAX:

IdentObj getLineRiser();
IdentObj getLineRiser (int s, int g);

INPUT:

s, g: optional series and group number

EXAMPLE:

setGraphType (41);
setLineWidth (getLineRiser (1, 3), 10);

getLineRiserSide/Top()

These methods return the object IDs of the side and top of risers in a line chart.

SYNTAX:

IdentObj getLineRiserSide();
IdentObj getLineRiserTop();

getMonthScaleLabel()

This method returns the object ID of the month scale labels in a Gantt chart. This object is only available in the chart when the DateScale property is set to DATESCALE_MONTHS (3).

SYNTAX:

IdentObj getMonthScaleLabel()

EXAMPLE:

setGraphType (99);
setFillColor (getMonthScaleLabel(), new Color (255, 0, 0));

getNestedO1Label0...8()

These methods return the object ID of each of the nested labels (0...8) that can be enabled with the NestedLabels property.

SYNTAX:

IdentObj getNestedO1Label0()
IdentObj getNestedO1Label1()
IdentObj getNestedO1Label2()
IdentObj getNestedO1Label3()
IdentObj getNestedO1Label4()
IdentObj getNestedO1Label5()
IdentObj getNestedO1Label6()
IdentObj getNestedO1Label7()
IdentObj getNestedO1Label8()

EXAMPLE:

setNestedLabels (true);
setDisplay (getNestedO1Labels0(), true);

getNestedO1Label0...8Box()

These methods return the object ID of each of the text boxes behind nested labels (0...8) that can be enabled with the NestedLabels property.

SYNTAX:

IdentObj getNestedO1Label0Box()
IdentObj getNestedO1Label1Box()
IdentObj getNestedO1Label2Box()
IdentObj getNestedO1Label3Box()
IdentObj getNestedO1Label4Box()
IdentObj getNestedO1Label5Box()
IdentObj getNestedO1Label6Box()
IdentObj getNestedO1Label7Box()
IdentObj getNestedO1Label8Box()

getNestedO1LabelLine()

This method gets the object ID of the line that can be drawn below group axis nested labels.

SYNTAX:

IdentObj getNestedO1LabelLine()

EXAMPLE:

setDisplay (getNestedO1Label0(), true);
setLineWidth (getNestedO1LabelLine(), 6);
setNestedLabels (true);

getNonZeroBaseLineZeroLine()

When setNonZeroBaseline() and setNonZeroBaselineValue() methods define a non-zero baseline, this method returns the object of the non-zero baseline.

SYNTAX:

IdentObj getNonZeroBaseLineZeroLine (IdentObj axisObj)

INPUT:

axisObj; the object ID of an axis where a non-zero baseline is defined.

EXAMPLE:

setNonZeroBaseline (getY1Axis(), true);
setNonZeroBaselineValue (getY1Axis(), 20);
setLineWidth (getNonZeroBaseLineZeroLine (getY1Axis()), 5);
setFillColor (getNonZeroBaseLineZeroLine (getY1Axis()), new Color (255, 0, 0));

getO1AltFmtFrame()

If nIndex is not specified, this method returns the object ID of the alternate formatted O1-Axis frame. If nIndex is specified, this method returns the object ID of a section of the alternate formatted O1-Axis frame.

SYNTAX:

IdentObj getO1AltFmtFrame();
IdentObj getO1AltFmtFrame(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getO1AltFmtFrame(), true);
setDisplay(getO1AltFmtLabel(), true);
setFillColor(getO1AltFmtLabel(0), new Color(0,0,160));
setTextString(getO1AltFmtLabel(0), "Label Section 0");
setAltFmtFrameNumColors(getO1AltFmtFrame(), 2); 
setAltFmtFrameSeparator(getO1AltFmtFrame(0), 3.0); 
setDisplay(getO1AltFmtFrame(0), true); 
setDisplay(getO1AltFmtFrame(1), true); 
setFillColor(getO1AltFmtFrame(1), new Color(255,128,255)); 
setFillColor(getO1AltFmtFrame(0), new Color(0,255,255));

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getO1AltFmtLabel()

If nIndex is not specified, this method returns the object ID of the alternate formatted O1-Axis labels. If nIndex is specified, this method returns the object ID of a section of the alternate formatted O1-Axis labels.

SYNTAX:

IdentObj getO1AltFmtLabel();
IdentObj getO1AltFmtLabel(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

See getO1AltFmtFrame()

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getO1Axis()

This method returns the object ID of the primary ordinal (O1) axis.

SYNTAX:

IdentObj getO1Axis();

EXAMPLE:

setAxisSide (getO1Axis(), 2);

getO1AxisLine()

This method returns the object ID of the O1-axis base line.

SYNTAX:

IdentObj getO1AxisLine();

EXAMPLE:

setLineWidth (getO1AxisLine(), 5);

getO1Label()

This method returns the object ID of labels on the O1 axis.

SYNTAX:

IdentObj getO1Label();
IdentObj getO1Label (int g);

INPUT:

g: an optional group number

EXAMPLE:

setAutofit (getO1Label(), false);
setFontSizeVC (getO1Label(), 2800);

getO1MajorGrid()

This method returns the object ID of the primary ordinal (O1) axis grid lines.

SYNTAX:

IdentObj getO1MajorGrid();

EXAMPLE:

setDisplay (getO1MinorGrid(), true);
setGridStyle (getO1MajorGrid(), 2);
setGridStyle (getO1MinorGrid(), 1);

getO1MajorTick()

This method returns the object ID of major tick marks on the primary ordinal (O1) axis. The tick marks are enabled with the O1MajorTickDisplay property.

SYNTAX:

IdentObj getO1MajorTick()

EXAMPLE:

setO1MajorTickDisplay (true);
setTickLength (getO1MajorTick(), 1000);
setBorderColor (getO1MajorTick(), new Color (255, 0, 0));

getO1MinorGrid()

This method returns the object ID of the primary ordinal (O1) axis minor grid lines.

SYNTAX:

IdentObj getO1MinorGrid();

EXAMPLE:

setDisplay (getO1MinorGrid(), true);
setGridStyle (getO1MajorGrid(), 2);
setGridStyle (getO1MinorGrid(), 1);

getO1MinorTick()

This method returns the object ID of minor tick marks on the primary ordinal (O1) axis. The tick marks are enabled with the O1MinorTickDisplay property.

SYNTAX:

IdentObj getO1MinorTick()

EXAMPLE:

setO1MinorTickDisplay (true);
setTickLength (getO1MinorTick(), 1000);
setBorderColor (getO1MinorTick(), new Color (255, 0, 0));

getO1Title()

This method returns the object ID of the primary ordinal (O1) axis title.

SYNTAX:

IdentObj getO1Title();

EXAMPLE:

setO1TitleString ("O1 AXIS TITLE");
setDisplay (getO1Title(), true);

getO1TitleBox()

This method returns the object ID of the primary ordinal (O1) axis title box.

SYNTAX:

IdentObj getO1TitleBox();

EXAMPLE:

setO1TitleString ("O1-Axis Title");
setDisplay (getO1TitleBox(), true);
setFillColor (getO1TitleBox(), new Color (255, 0, 0));

getO2Axis()

This method returns the object ID of the secondary ordinal (O2) axis.

SYNTAX:

IdentObj getO2Axis();

EXAMPLE:

setGraphType (87);
setAxisSide (getO2Axis(), 1);

getO2AxisLine()

This method returns the object ID of the secondary ordinal (O2) axis base line that only appears in 3D charts and spectral maps.

SYNTAX:

IdentObj getO2AxisLine();

getO2Label()

This method returns the object ID of the secondary ordinal (O2) axis labels.

SYNTAX:

IdentObj getO2Label();

EXAMPLE:

setGraphType (0);
setFontSizeVC (getO2Label(), 1000);
setFontStyle (getO2Label(), 6);

getO2MajorGrid()

This method returns the object ID of the secondary ordinal (O2) axis major grid lines.

SYNTAX:

IdentObj getO2MajorGrid();

EXAMPLE:

setGraphType (87);
setGridStyle (getO2MajorGrid(), 4);

getO2MinorGrid()

This method returns the object ID of the secondary ordinal (O2) axis minor grid lines.

SYNTAX:

IdentObj getO2MinorGrid();

EXAMPLE:

setGraphType (87);
setGridStyle (getO2MajorGrid(), 4);
setDisplay (getO2MinorGrid(), true);
setLineWidth (getO2MinorGrid(), 4);
setFillColor (getO2MinorGrid(), new Color (0, 255, 0));

getO2Title()

This method returns the object ID of the secondary ordinal (O2) axis title.

SYNTAX:

IdentObj getO2Title();

EXAMPLE:

setO2TitleString ("O2 AXIS");
setGraphType (87);
setDisplay (getO2Title(), true);

getO2TitleBox()

This method returns the object ID of the secondary ordinal (O2) axis title box.

SYNTAX:

IdentObj getO2TitleBox();

EXAMPLE:

setGraphType (0);
setO1TitleString ("O1-Axis Title");
setDisplay (getO1TitleBox(), true);
setFillColor (getO1TitleBox(), new Color (0, 255, 0));
setO2TitleString ("O2-Axis Title");
setDisplay (getO2TitleBox(), true);
setFillColor (getO2TitleBox(), new Color (255, 0, 0));

getParetoChartFrame1()

This method returns the object ID of the frame 1 object in a pareto chart.

SYNTAX:

IdentObj getParetoChartFrame1()

EXAMPLE:

setGraphType (102);
setParetoDisplayThreshold (50);
setFillColor (getParetoChartFrame2(), new Color (0, 255, 0));
setFillColor (getParetoLineRiser2(), new Color (255, 0, 0));
setFillColor (getParetoLineRiser1(), new Color (255, 255, 0));
setFillColor (getParetoChartFrame1(), new Color (255, 0, 0));

getParetoChartFrame2()

When a pareto chart frame is split with ParetoDisplayThreshold, this method returns the object ID of frame 2 in a pareto chart.

SYNTAX:

IdentObj getParetoChartFrame2()

EXAMPLE:

setGraphType (102);
setParetoDisplayThreshold (50);
setFillColor (getParetoChartFrame2(), new Color (255, 125, 0));
setFillColor (getParetoLineRiser2(), new Color (255, 0, 0));
setFillColor (getParetoLineRiser1(), new Color (255, 255, 0));
setFillColor (getParetoChartFrame1(), new Color (125, 125, 0));

getParetoLineMarker()

This method returns the object ID of the markers in the line riser in a pareto chart.

SYNTAX:

IdentObj getParetoLineMarker()

EXAMPLE:

setGraphType (102);
setFillColor (getParetoLineMarker(), new Color (0, 255, 255));

getParetoLineRiser()

This method returns the object ID of the line riser in a pareto chart.

SYNTAX:

IdentObj getParetoLineRiser()

EXAMPLE:

setGraphType (102);
setFillColor (getParetoLineMarker(), new Color (0, 255, 255));
setFillColor (getParetoLineRiser(), new Color (0, 255, 0));

getParetoLineRiser1()

This method returns the object ID of the line riser 1 object in a pareto chart.

SYNTAX:

IdentObj getParetoLineRiser1()

EXAMPLE:

setGraphType (102);
setParetoDisplayThreshold (50);
setFillColor (getParetoChartFrame2(), new Color (225, 235, 245));
setFillColor (getParetoLineRiser2(), new Color (255, 0, 0));
setFillColor (getParetoLineRiser1(), new Color (255, 255, 0));
setFillColor (getParetoChartFrame1(),  new Color (205, 215, 225));

getParetoLineRiser2()

This method returns the object ID of the line riser 2 object in a pareto chart.

SYNTAX:

IdentObj getParetoLineRiser2()

EXAMPLE:

setGraphType (102);
setParetoDisplayThreshold (50);
setFillColor (getParetoChartFrame2(), new Color (225, 235, 245));
setFillColor (getParetoLineRiser2(), new Color (255, 255, 0));
setFillColor (getParetoLineRiser1(), new Color (255, 0, 0));
setFillColor (getParetoChartFrame1(),  new Color (205, 215, 225));

getParetoLineRiserSide/1/2()

These methods return the object ID of the sides of the line riser in a pareto chart.

SYNTAX:

IdentObj getParetoLineRiserSide()
IdentObj getParetoLineRiserSide1()
IdentObj getParetoLineRiserSide2()

getParetoLineRiserTop/1/2()

These methods return the object ID of the top of the line riser in a pareto chart

SYNTAX:

IdentObj getParetoLineRiserTop()
IdentObj getParetoLineRiserTop1()
IdentObj getParetoLineRiserTop2()

getPercentCompleteBar()

This method returns the object ID of the percent complete bar in a gantt chart.

SYNTAX:

IdentObj getPercentCompleteBar()

EXAMPLE:

setGraphType (99);
setFillColor (getPercentCompleteBar(), new Color (255, 0, 0));

getPercentCompleteLabel()

This method returns the object ID of the text labels in the PercentCompleteBar objects in a gantt chart.

SYNTAX:

IdentObj getPercentCompleteLabel()

EXAMPLE:

setGraphType (99);
setFillColor (getPercentCompleteLabel(), new Color (255, 0, 0));

getPercentCompleteTopLabel()

This method returns the object ID of the percent complete label that is shown on the right side of a gantt chart.

SYNTAX:

IdentObj getPercentCompleteTopLabel()

EXAMPLE:

setGraphType (99);
setFontStyle (getPercentCompleteTopLabel(), 7);

getPieBarConnectLineBottom()

This method returns the object ID of the bottom line that connects the bar to a series in a pie-bar chart (GraphType 93 or 94).

SYNTAX:

IdentObj getPieBarConnectLineBottom();

getPieBarConnectLines()

This method returns the object ID of the lines that connect the bar to a series in a pie-bar chart (GraphType 93 or 94).

SYNTAX:

IdentObj getPieBarConnectLines();

EXAMPLE:

setGraphType (93);
setLineWidth (getPieBarConnectLines(), 10);

getPieBarConnectLineTop()

This method returns the object ID of the top line that connects the bar to a series in a pie-bar chart (GraphType 93 or 94).

SYNTAX:

IdentObj getPieBarConnectLineTop();

getPieBarLabel()

This method returns the object ID of the bar label to a series in a pie-bar chart.

SYNTAX:

IdentObj getPieBarLabel()

getPieBarRiser()

This method returns the object ID of the bar riser in a pie-bar chart.

SYNTAX:

IdentObj getPieBarRiser();

getPieBarRiserSide/Top()

These methods return the object ID of the side and top of the bar riser in a pie-bar chart.

SYNTAX:

IdentObj getPieBarRiserSide();
IdentObj getPieBarRiserTop();

getPieBarSlice()

This method returns the object ID of a slice in a pie-bar chart.

SYNTAX:

IdentObj getPieBarSlice();
IdentObj getPieBarSlice (int s, int g);

INPUT:

s, g: optional series and group number

getPieBarSliceCrust()

This method returns the object ID of the slice crust in a pie-bar chart.

SYNTAX:

IdentObj getPieBarSliceCrust();

getPieFeelerLine()

This method returns the object ID of pie feeler lines in a pie chart.

SYNTAX:

IdentObj getPieFeelerLine();
IdentObj getPieFeelerLine (int s, int g);

INPUT:

s/g: optional series and group number

EXAMPLE:

setGraphType (55);
setLineWidth (getPieFeelerLine(), 5);

getPieFrame()

This method returns the object ID of the frame of a pie chart.

SYNTAX:

IdentObj getPieFrame();

EXAMPLE:

setGraphType (55);
setDisplay (getPieFrame(), true);
setFillColor (getPieFrame(), new Color (210, 225, 235));
setBorderColor (getPieFrame(), new Color (0, 0, 0));

getPieLabel()

This method returns the object ID of group labels in multiple pie charts.

SYNTAX:

IdentObj getPieLabel();
IdentObj getPieLabel (int g);

INPUT:

g; Optional group number

EXAMPLE:

setGraphType (57);
setFontStyle (getPieLabel (2), 6)

getPieRingLabel()

This method returns the object ID of the total label that may be displayed in the center ring of a ring pie chart.

SYNTAX:

IdentObj getPieRingLabel();
IdentObj getPieRingLabel (int g);

INPUT:

g: an optional group number

EXAMPLE:

setGraphType (56);
setDisplay (getPieRingLabel(), false);

getPieSliceLabel()

This method returns the object ID slice labels in a pie chart.

SYNTAX:

IdentObj getPieSliceLabel();
IdentObj getPieSliceLabel (int s, int g);

INPUT:

s, g; optional series and group number

EXAMPLE:

setFontSizeVC (getPieSliceLabel(), 1623);
setFontStyle (getPieSliceLabel(), 3);
setGraphType (55);

getPlaceHorzO1LabelsTitle()

When the automatic chart layout manager is enabled with setPlace (true), this method returns the object ID of a rectangle that is the virtual coordinate location/size of the O1-Axis Labels and Titles. This method is used for horizontal chart types. The important coordinates of this rectangle identifier are X-location and height. The setPlaceRect() method is used with this object.

SYNTAX:

IdentObj getPlaceHorzO1LabelsTitle()

EXAMPLE:

setGraphType (24);
setPlaceRect (getPlaceHorzO1LabelsTitle(), new Rectangle (-14000, -15500, 28000, 24000));

getPlaceVertO1LabelsTitle()

When the automatic chart layout manager is enabled with setPlace (true), this method returns the object ID of a rectangle that is the virtual coordinate location and size of both the O1-Axis Labels and Titles. This method is used for vertical chart types. Note that the important coordinates of this rectangle identifier are Y-location and height. The setPlaceRect() method is used with this object.

SYNTAX:

IdentObj getPlaceVertO1LabelsTitle()

EXAMPLE:

setPlaceRect (getPlaceVertO1LabelsTitle(), new Rectangle (-14000, -15500, 29000, 24000));

getQuadrantLine()

This method returns the object ID of the quadrant lines in a bubble chart.

SYNTAX:

IdentObj getQuadrantLine();

EXAMPLE:

setGraphType (89);
setDepthRadius(0);
setFillColor(getQuadrantLine(), new Color (255,0,0));

getQualityLegendArea()

This method returns the object ID the quality legend area in a Gantt chart.

SYNTAX:

IdentObj getQualityLegendArea();

EXAMPLE:

setDisplay (getQualityLegendArea(), true);
setBorderColor (getQualityLegendArea(), new Color (255, 0, 0));

getReferenceLine()

This method returns the object ID of a reference line. This object will only exist in a chart if the setReferenceLine() method has been used to create the line.

SYNTAX:

IdentObj getReferenceLine (IdentObj axisObj, int nIndex)

INPUT:

axisObj: Axis object ID

nIndex: integer reference line index number (0...2)

EXAMPLE:

setReferenceLine (getY1Axis(), 0, 50);
setLineWidth (getReferenceLine (getY1Axis(), 0), 3);
setFillColor (getReferenceLine (getY1Axis(), 0), new Color (255, 0, 0));

getReferenceLineLegendText()

This method returns the object ID of the legend text associated with a reference line.

SYNTAX:

IdentObj getReferenceLineLegendText (IdentObj axisObj, int nIndex)

INPUT:

axisObj: Axis object ID

nIndex: integer reference line index number (0...2)

EXAMPLE:

setReferenceLine (getY1Axis(), 0, 50);
setLineWidth (getReferenceLine (getY1Axis(), 0), 3);
setFillColor (getReferenceLine (getY1Axis(), 0), new Color (255, 0, 0));
setTextString (getReferenceLine (getY1Axis(), 0), "RefLine");
setDisplay (getReferenceLineLegendText (getY1Axis(), 0), true)

getRollupDot()

This method returns the object ID of the roll-up dot that is shown when a task is rolled up in a gantt chart.

SYNTAX:

IdentObj getRollupDot()

getRollupLabel()

This method returns the object ID that shown below the getRollupDot() object when a task is rolled up in a Gantt chart.

SYNTAX:

IdentObj getRollupLabel()

EXAMPLE:

setGraphType (99);
setFontStyle (getRollupLabel(), 7);
setFontSizeVC (getRollupLabel(), 1000);

getScatterQuadrantLine()

This method returns the object ID of the quadrant lines in a scatter chart.

SYNTAX:

IdentObj getScatterQuadrantLine();

EXAMPLE:

setDisplay (getScatterQuadrantLine(), true);
setGraphType (61);

getSelectionID()

This method returns the object ID of the first item in the selection list.

SYNTAX:

IdentObj getSelectionID();

getSeries()

This method returns the object ID of the series specified by nSeries.

SYNTAX:

IdentObj getSeries (int nSeries);

INPUT:

nSeries: Any valid series number.

EXAMPLE:

setMarkerShape (getSeries (0), 1);
setMarkerShape (getSeries (1), 2);
setMarkerShape (getSeries (2), 3);

getSeriesGroup()

This method returns the object ID of the series associated with nSeries and nGroup.

SYNTAX:

IdentObj getSeriesGroup (int nSeries, int nGroup);

INPUT:

nSeries, nGroup: Any valid series & group number

EXAMPLE:

setDataValue (getSeriesGroup (0, 0), 100);
setDataValue (getSeriesGroup (0, 1), 50);
setDataValue (getSeriesGroup (1, 0), 25);
setDataValue (getSeriesGroup (1, 1), 5);

getSeriesScroller()

This method returns the object ID of the Series data scrolling bar that can be enabled and displayed with the DataScrollerPresenceSeries property.

SYNTAX:

IdentObj getSeriesScroller();

EXAMPLE:

setRect (getSeriesScroller(),  new Rectangle (-14180, -13600, 20124, 927));

getSeriesScrollerEditBox()

This method returns the object ID of the Series data scrolling edit box that can be enabled and displayed with the DataScrollerPresenceSeries property. The edit box is the right-most portion of the scroller bar that contains three number identifying the scroll offset series, viewable series, and total number of series. The edit box can be edited in the user interface.

SYNTAX:

IdentObj getSeriesScrollerEditBox();

getSeriesScrollerEditLeft()

This method returns the object ID of the Series data scrolling left edit bar that can be enabled and displayed with the DataScrollerPresenceSeriess property. This object is the left most digit in the series scroller edit box.

SYNTAX:

IdentObj getSeriesScrollerEditLeft();

getSeriesScrollerEditRight()

This method returns the object ID of the Series data scrolling right edit bar that can be enabled and displayed with the DataScrollerPresenceSeries property. This object is the right most digits in the series scroller edit box.

SYNTAX:

IdentObj getSeriesScrollerEditRight();

getSeriesScrollerEditThumb()

This method returns the object ID of the Series data scrolling bar edit thumb that can be enabled and displayed with the DataScrollerPresenceSeries property. This object is the center digit in the series scroller edit box.

SYNTAX:

IdentObj getSeriesScrollerEditThumb();

getSeriesScrollerThumb()

This method returns the object ID of the series scroller edit thumb. The series scroller bar is enabled and displayed with the DataScrollerPresenceSeries property. The thumb is the movable area of the scroller bar that can be used to adjust the series offset.

SYNTAX:

IdentObj getSeriesScrollerThumb();

getSlice()

This method returns the object ID of a slice in a pie chart.

SYNTAX:

IdentObj getSlice();
IdentObj getSlice (int s, int g);

INPUT:

s/g: an optional series and group number

getSliceCrust()

This method returns the object ID of the slice crust in a pie chart.

SYNTAX:

IdentObj getSliceCrust();

getSliceRing()

This method returns the object ID of a slice in a ring pie chart.

SYNTAX:

IdentObj getSliceRing();

getSpectralLegendMarker()

This method returns the object ID of the legend marker in a specral map.

SYNTAX:

IdentObj getSpectralLegendMarker();
IdentObj getSpectralLegendMarker (int i);

INPUT:

i: legend marker number

EXAMPLE:

setGraphType (87);
setBorderColor (getSpectralLegendMarker (0), new Color (255, 0, 0));

getSpectralMarker()

This method returns the object ID of the markers in a specral map.

SYNTAX:

IdentObj getSpectralMarker();

getStock52WeekHighLine()

This method returns the object ID of the 52-week high line that may be displayed in a stock chart.

SYNTAX:

IdentObj getStock52WeekHighLine();

EXAMPLE:

setDisplay (getStock52WeekHighLine(), true);
setGraphType (73);
setStock52WeekHighValue (40.0);

getStock52WeekLowLine()

This method returns the object ID of the 52-week low line that may be displayed in a stock chart.

SYNTAX:

IdentObj getStock52WeekLowLine();

EXAMPLE:

setDisplay (getStock52WeekLowLine(), true);
setGraphType (73);
setStock52WeekLowValue (10.0);

getStockCloseTick()

This method returns the object ID of close ticks in a stock chart.

SYNTAX:

IdentObj getStockCloseTick();
IdentObj getStockCloseTick (int s, int g);

INPUT:

s, g: an optional series and group number

EXAMPLE:

setGraphType (76);
setDisplay (getStockCloseTick(), false);

getStockFallingRiser()

This method returns the object ID of the falling riser in a stock chart.

SYNTAX:

IdentObj getStockFallingRiser();
IdentObj getStockFallingRiser (int s, int g);

INPUT:

s, g: an optional series and group number

getStockHighLine()

This method returns the object ID of the high line in a stock chart.

SYNTAX:

IdentObj getStockHighLine();

getStockLowerRiser()

This method returns the object ID of the lower risers in a stock chart.

SYNTAX:

IdentObj getStockLowerRiser();

getStockLowLine()

This method returns the object ID of the low line that may be visible in a stock chart.

SYNTAX:

IdentObj getStockLowLine();

getStockMALine()

This method returns the object ID of the moving average line that may be visible in a stock chart.

SYNTAX:

IdentObj getStockMALine();
IdentObj getStockMALine (int s, int g);

INPUT:

s, g: an optional series and group number

EXAMPLE:

setDisplay (getStockMALine(), true);
setGraphType (84);

getStockOpenTick()

This method returns the object ID of open ticks that may be visible in a stock chart.

SYNTAX:

IdentObj getStockOpenTick();
IdentObj getStockOpenTick (int s, int g);

INPUT:

s, g: an optional series and group number

EXAMPLE:

setGraphType (83);
setDisplay (getStockOpenTick(), true);
setDisplay (getStockCloseTick(), false);
setLineWidth (getStockOpenTick(), 2);
setBorderColor (getStockOpenTick(),  new Color (255, 0, 0));

getStockRiser()

This method returns the object ID of risers in a stock chart.

SYNTAX:

IdentObj getStockRiser();

getStockRisingRiser()

This method returns the object ID of rising risers in a stock chart. Specify a series (s) and group (g) number to get the rising riser for a particular series and group.

SYNTAX:

IdentObj getStockRisingRiser();
IdentObj getStockRisingRiser (int s, int g);

INPUT:

s, g: an optional series and group number

getStockVolumeRiser()

This method returns the object ID of volume risers in a stock chart. Use the group (g) parameter to get the object ID of volume risers for a particular group.

SYNTAX:

IdentObj getStockVolumeRiser();
IdentObj getStockVolumeRiser (int g);

INPUT:

g: an optional group number

EXAMPLE:

setFillColor (getStockVolumeRiser(), new Color (255, 0, 0));
setGraphType (82);

getSubtitle()

This method returns the object ID of the chart subtitle.

SYNTAX:

IdentObj getSubtitle();

EXAMPLE:

setFontStyle (getSubtitle(), 7);
setFillColor (getSubtitle(), new Color (0, 255, 0));

getSubtitleBox()

This method returns the object ID of the chart subtitle box.

SYNTAX:

IdentObj getSubtitleBox()

EXAMPLE:

setDisplay (getSubtitleBox(), true);
setFillColor (getSubtitleBox(), new Color (255, 0, 0));

getTask1/2()

These methods return the object ID of the tasks in a gantt chart.

SYNTAX:

IdentObj getTask1()
IdentObj getTask2()

getTaskLabel()

This method returns the object ID of the task labels in a gantt chart.

SYNTAX:

IdentObj getTaskLabel()

EXAMPLE:

setGraphType (99);
setFontSizeVC (getTaskLabel(), 800);
setFontStyle (getTaskLabel(), 7);

getTimeScaleLevel()

This method returns the object ID of a level (0...2) on a time scale axis.

SYNTAX:

IdentObj getTimeScaleLevel (level);

INPUT:

level; a time scale axis level 0...2

EXAMPLE:

setLevelBorderColor (getTimeScaleLevel (1), new Color (255, 0, 0));

getTitle()

This method returns the object ID of the chart title.

SYNTAX:

IdentObj getTitle();

EXAMPLE:

setAutofit (getTitle(), false);
setFontName (getTitle(), "Vivaldi");
setFontSize (getTitle(), 48);
setFontSizeAbsolute (getTitle(), true);
setFontStyle (getTitle(), 3);
setSubtitleDisplay (false);
setTitleString ("A Very Fancy Chart Title");
setRect (getTitle(), new Rectangle (-13471, 11992, 25806, 1539));

getTitleBox()

This method returns the object ID of the chart title box.

SYNTAX:

IdentObj getTitleBox()

EXAMPLE:

setDisplay (getTitleBox(), true);
setFillColor (getTitleBox(), new Color (255, 0, 0));

getWaterfallLine()

This method returns the object ID of the line that connects risers in a waterfall chart.

SYNTAX:

IdentObj getWaterfallLine()

EXAMPLE:

setGraphType (100); 
setLineWidth (getWaterfallLine(), 5);
setFillColor (getWaterfallLine(), new Color (255, 0, 0));

getWeekdaysScaleLabel()

This method returns the object ID of the weekdays scale label.

SYNTAX:

IdentObj getWeekdaysScaleLabel()

EXAMPLE:

setGraphType (99);
setDateScale (2);
setFontSizeVC (getWeekdaysScaleLabel(), 900);
setAutofit (getWeekdaysScaleLabel(), false);
setFillColor (getWeekdaysScaleLabel(), new Color (255, 0, 0));

getX1AltFmtFrame()

If nIndex is not specified, this method returns the object ID of the alternate formatted X1-Axis frame. If nIndex is specified, this method returns the object ID of a section of the alternate formatted X1-Axis frame.

SYNTAX:

IdentObj getX1AltFmtFrame();
IdentObj getX1AltFmtFrame(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getX1AltFmtFrame(),true);
setDisplay(getX1AltFmtFrame(0),true);
setDisplay(getX1AltFmtFrame(1),true);
setDisplay(getX1AltFmtFrame(2),true);
setAltFmtFrameNumColors(getX1AltFmtFrame(),3);
setAltFmtFrameSeparator(getX1AltFmtFrame(0),30.0);
setAltFmtFrameSeparator(getX1AltFmtFrame(1),45.0);
setFillColor(getX1AltFmtFrame(0),new Color(255,0,0));
setFillColor(getX1AltFmtFrame(1),new Color(255,255,0));
setFillColor(getX1AltFmtFrame(2),new Color(0,255,0));
setGraphType(62);

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getX1AltFmtLabel()

If nIndex is not specified, this method returns the object ID of the alternate formatted X1-Axis labels. If nIndex is specified, this method returns the object ID of a section of the alternate formatted X1-Axis labels.

SYNTAX:

IdentObj getX1AltFmtLabel();
IdentObj getX1AltFmtLabel(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getX1AltFmtFrame(),true);
setDisplay(getX1AltFmtFrame(0),true);
setDisplay(getX1AltFmtFrame(1),true);
setDisplay(getX1AltFmtFrame(2),true);
setDisplay(getX1AltFmtLabel(), true);
setTextString(getX1AltFmtLabel(2), "Label Section 0");
setFillColor(getX1AltFmtLabel(2), new Color(0,0,0));
setAltFmtFrameNumColors(getX1AltFmtFrame(),3);
setAltFmtFrameSeparator(getX1AltFmtFrame(0),30.0);
setAltFmtFrameSeparator(getX1AltFmtFrame(1),45.0);
setFillColor(getX1AltFmtFrame(0),new Color(255,0,0));
setFillColor(getX1AltFmtFrame(1),new Color(255,255,0));
setFillColor(getX1AltFmtFrame(2),new Color(0,255,0));
setGraphType(62);

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getX1Axis()

This method returns the object ID of the X-axis.

SYNTAX:

IdentObj getX1Axis();

EXAMPLE:

setGraphType (61);
setAxisDescending (getX1Axis(), true);

getX1AxisLine()

This method returns the object ID of the X-axis base line.

SYNTAX:

IdentObj getX1AxisLine();

EXAMPLE:

setGraphType (61);
setDisplay (getX1AxisLine(), true);
setLineWidth (getX1AxisLine(), 5);

getX1Label()

This method returns the object ID of labels on the X-axis.

SYNTAX:

IdentObj getX1Label();

EXAMPLE:

setGraphType (61);
setFontStyle (getX1Label(), 4);

getX1MajorGrid()

This method returns the object ID of the X1-axis major grid lines.

SYNTAX:

IdentObj getX1MajorGrid();

EXAMPLE:

setGraphType (61);
setGridStep (getX1MajorGrid(), 20.0);
setGridStep (getY1MajorGrid(), 10.0);
setGridStepAuto (getX1MinorGrid(), true);
setGridStepAuto (getX1MajorGrid(), false);

getX1MajorTick()

This method returns the object ID of the X1-axis major tick marks.

SYNTAX:

IdentObj getX1MajorTick()

EXAMPLE:

setGraphType (61);
setX1MajorTickDisplay (true);
setTickLength (getX1MajorTick(), 2000);
setBorderColor (getX1MajorTick(), new Color (255, 0, 0));

getX1MinorGrid()

This method returns the object ID of the X1-axis minor grid lines.

SYNTAX:

IdentObj getX1MinorGrid();

EXAMPLE:

setGraphType (61);
setGridStep (getX1MajorGrid(), 20.0);
setGridStep (getY1MajorGrid(), 10.0);
setGridStepAuto (getX1MinorGrid(), true);
setGridStepAuto (getX1MajorGrid(), false);

getX1MinorTick()

This method returns the object ID of the X1-axis minor tick marks.

SYNTAX:

IdentObj getX1MinorTick()

EXAMPLE:

setGraphType (61);
setX1MinorTickDisplay (true);
setTickLength (getX1MinorTick(), 2000);
setBorderColor (getX1MinorTick(), new Color (255, 0, 0));

getX1Title()

This method returns the object ID of the X1-axis title.

SYNTAX:

IdentObj getX1Title();

EXAMPLE:

setGraphType (61);
setX1TitleString ("X1 AXIS");
setDisplay (getX1Title(), true);

getX1TitleBox()

This method returns the object ID of the title box on a chart with an X1 axis.

SYNTAX:

IdentObj getX1TitleBox()

EXAMPLE:

setGraphType (61); 
setX1TitleString ("X1 Axis Title");
setY1TitleString ("Y1 Axis Title");
setTitleString ("GraphType (61)");
setSubtitleString ("Scatter Chart");
setFillColor (getX1TitleBox(), new Color (255, 0, 0));
setDisplay (getX1TitleBox(), true);

getX1ZeroLine()

This method returns the object ID of the X1-axis zero line.

SYNTAX:

IdentObj getX1ZeroLine();

EXAMPLE:

setDisplay (getX1ZeroLine(), true);
setGraphType (61);
setLineWidth (getX1ZeroLine(), 5);

getY1AltFmtFrame()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y1-Axis frame. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y1-Axis frame.

SYNTAX:

IdentObj getY1AltFmtFrame();
IdentObj getY1AltFmtFrame(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getY1AltFmtFrame(), true); 
setAltFmtFrameNumColors(getY1AltFmtFrame(), 2); 
setAltFmtFrameSeparator(getY1AltFmtFrame(0), 30.0); 
setDisplay(getY1AltFmtFrame(0), true); 
setDisplay(getY1AltFmtFrame(1), true); 
setFillColor(getY1AltFmtFrame(0), new Color(0,255,255)); 
setFillColor(getY1AltFmtFrame(1), new Color(255,255,0));
setDisplay(getY1AltFmtLabel(), true);
setTextString(getY1AltFmtLabel(0), "Label Section 0"); 
setTextString(getY1AltFmtLabel(1), "Label Section 1");
setFillColor(getY1AltFmtLabel(0), new Color(0,0,0)); 
setFillColor(getY1AltFmtLabel(1), new Color(0,0,0));
setGraphType(41);
setDepthRadius(10);

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY1AltFmtLabel()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y1-Axis labels. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y1-Axis labels.

SYNTAX:

IdentObj getY1AltFmtLabel();
IdentObj getY1AltFmtLabel(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

See getY1AltFmtFrame()

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY1Axis()

This method returns the object ID of the Y1 axis.

SYNTAX:

IdentObj getY1Axis();

EXAMPLE:

setGraphType (61); 
setAxisDescending (getY1Axis(), true);

getY1AxisLine()

This method returns the object ID of the Y1-axis base line.

SYNTAX:

IdentObj getY1AxisLine();

EXAMPLE:

setY1TitleString ("Y1TITLE");
setDisplay (getY1Title(), true);
setLineWidth (getY1AxisLine(), 5);

getY1Label()

This method returns the object ID of labels on the Y1-axis.

SYNTAX:

IdentObj getY1Label();

EXAMPLE:

setAutofit (getY1Label(), false);
setFontSizeVC (getY1Label(), 2500);
setFontStyle (getY1Label(), 4);

getY1MajorGrid()

This method returns the object ID of the Y1-axis major grid lines.

SYNTAX:

IdentObj getY1MajorGrid();

EXAMPLE:

setGraphType (61);
setGridStep (getX1MajorGrid(), 20.0);
setGridStep (getY1MajorGrid(), 10.0);
setGridStepAuto (getX1MinorGrid(), true);
setGridStepAuto (getX1MajorGrid(), false);

getY1MajorTick()

This method returns the object ID of major tick marks that may be drawn on the Y1 axis. These tick marks are enabled/disabled with the Y1MajorTickDisplay property.

SYNTAX:

IdentObj getY1MajorTick()

EXAMPLE:

setY1MajorGridDisplay (false);
setY1MajorTickDisplay (true);
setTickLength (getY1MajorTick(), 1000);
setBorderColor (getY1MajorTick(), new Color (255, 0, 0));

getY1MinorGrid()

This method returns the object ID of the Y1-axis minor grid lines.

SYNTAX:

IdentObj getY1MinorGrid();

EXAMPLE:

setDisplay (getY1MinorGrid(), true);
setGridStyle (getY1MinorGrid(), 3);

getY1MinorTick()

This method returns the object ID of minor tick marks that may be drawn on the Y1 axis. These tick marks are enabled/disabled with the Y1MinorTickDisplay property.

SYNTAX:

IdentObj getY1MinorTick()

EXAMPLE:

setY1MinorGridDisplay (false);
setY1MinorTickDisplay (true);
setTickLength (getY1MinorTick(), 1000);
setBorderColor (getY1MinorTick(), new Color (255, 0, 0));

getY1Title()

This method returns the object ID of the Y1-axis title.

SYNTAX:

IdentObj getY1Title();

EXAMPLE:

setY1TitleString ("Y1 TITLE");
setDisplay (getY1Title(), true);

getY1TitleBox()

This method returns the object ID of the title box on a chart with an Y1 axis.

SYNTAX:

IdentObj getY1TitleBox()

EXAMPLE:

setGraphType (24);
setY1TitleString ("Y1 Axis Title");
setDisplay (getY1TitleBox(), true);
setFillColor (getY1TitleBox(), new Color (255, 0, 0));

getY1ZeroLine()

This method returns the object ID of the Y1-axis zero line.

SYNTAX:

IdentObj getY1ZeroLine();

EXAMPLE:

setDisplay (getY1ZeroLine(), true);
setLineWidth (getY1ZeroLine(), 5);
setFillColor (getY1ZeroLine(), new Color (255, 0, 0));

getY2AltFmtFrame()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y2-Axis frame. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y2-Axis frame.

SYNTAX:

IdentObj getY2AltFmtFrame();
IdentObj getY2AltFmtFrame(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getY2AltFmtFrame(), true);
setAltFmtFrameNumColors(getY2AltFmtFrame(), 4);
setAltFmtFrameSeparator(getY2AltFmtFrame(0), 30.0);
setAltFmtFrameSeparator(getY2AltFmtFrame(1), 45.0);
setAltFmtFrameSeparator(getY2AltFmtFrame(2), 50.0);
setDisplay(getY2AltFmtFrame(0), true);
setDisplay(getY2AltFmtFrame(1), true);
setDisplay(getY2AltFmtFrame(2), true);
setDisplay(getY2AltFmtFrame(3), true);
setFillColor(getY2AltFmtFrame(0), new Color(0,128,255));
setFillColor(getY2AltFmtFrame(1), new Color(128,255,0));
setFillColor(getY2AltFmtFrame(2), new Color(255,0,128));
setFillColor(getY2AltFmtFrame(3), new Color(255,255,0));
setGraphType(46);

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY2AltFmtLabel()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y2-Axis labels. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y2-Axis labels.

SYNTAX:

IdentObj getY2AltFmtLabel();
IdentObj getY2AltFmtLabel(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getY2AltFmtFrame(), true);
setDisplay(getY2AltFmtLabel(), true);
setAltFmtFrameNumColors(getY2AltFmtFrame(), 4);
setAltFmtFrameSeparator(getY2AltFmtFrame(0), 20.0);
setAltFmtFrameSeparator(getY2AltFmtFrame(1), 40.0);
setAltFmtFrameSeparator(getY2AltFmtFrame(2), 60.0);
setAltFmtFrameSeparator(getY2AltFmtFrame(3), 70.0);
setDisplay(getY2AltFmtFrame(0), true);
setDisplay(getY2AltFmtFrame(1), true);
setDisplay(getY2AltFmtFrame(2), true);
setDisplay(getY2AltFmtFrame(3), true);
setFillColor(getY2AltFmtFrame(0), new Color(0,128,255));
setFillColor(getY2AltFmtFrame(1), new Color(128,255,0));
setFillColor(getY2AltFmtFrame(2), new Color(255,0,128));
setFillColor(getY2AltFmtFrame(3), new Color(255,255,0));
setTextString(getY2AltFmtLabel(0), "Label Section 0"); 
setTextString(getY2AltFmtLabel(2), "Label Section 2");
setFillColor(getY2AltFmtLabel(0), new Color(0,0,0)); 
setFillColor(getY2AltFmtLabel(2), new Color(0,0,255));
setGraphType(46);
setDepthRadius(1);

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY2Axis()

This method returns the object ID of the Y2 axis.

SYNTAX:

IdentObj getY2Axis();

EXAMPLE:

setGraphType (21);
setDisplay (getY2AxisLine(), true);
setLineWidth (getY2AxisLine(), 5);
setAxisDescending (getY2Axis(), true);

getY2AxisLine()

This method returns the object ID of the Y2-axis base line.

SYNTAX:

IdentObj getY2AxisLine();

EXAMPLE:

setGraphType (21);
setDisplay (getY2AxisLine(), true);
setLineWidth (getY2AxisLine(), 5);

getY2Label()

This method returns the object ID of labels on the Y2-axis.

SYNTAX:

IdentObj getY2Label();

EXAMPLE:

setGraphType (21); 
setAutofit (getY2Label(), false);
setFontSizeVC (getY2Label(), 1500);

getY2MajorGrid()

This method returns the object ID of the Y2-axis major grid lines.

SYNTAX:

IdentObj getY2MajorGrid();

EXAMPLE:

setGraphType (21);
setY2MinorGridDisplay (true);
setY2MinorGridStyle (3);
setDisplay (getY2MajorGrid(), true);
setGridStyle (getY2MajorGrid(), 1);

getY2MajorTick()

This method returns the object ID of major tick marks that may be drawn on the Y2 axis. These tick marks are enabled/disabled with the Y2MajorTickDisplay property.

SYNTAX:

IdentObj getY2MajorTick()

EXAMPLE:

setY2MajorGridDisplay (false);
setY2MajorTickDisplay (true);
setTickLength (getY2MajorTick(), 1000);
setBorderColor (getY2MajorTick(), new Color (255, 0, 0));

getY2MinorGrid()

This method returns the object ID of the Y2-axis minor grid lines.

SYNTAX:

IdentObj getY2MinorGrid();

EXAMPLE:

setGraphType (21);
setDisplay (getY2MinorGrid(), true);
setGridStyle (getY2MinorGrid(), 2);

getY2MinorTick()

This method returns the object ID of minor tick marks that may be drawn on the Y2 axis. These tick marks are enabled/disabled with the Y2MinorTickDisplay property.

SYNTAX:

IdentObj getY2MinorTick()

EXAMPLE:

setY2MajorGridDisplay (false);
setY2MinorTickDisplay (true);
setY2MajorTickDisplay (true);
setTickLength (getY2MinorTick(), 1000);
setBorderColor (getY2MinorTick(), new Color (255, 0, 0));
setBorderColor (getY2MajorTick(), new Color (0, 0, 255));
setTickLength (getY2MajorTick(), 2000);

getY2Title()

This method returns the object ID of the Y2-axis title.

SYNTAX:

IdentObj getY2Title();

EXAMPLE:

setDisplay (getY2Title(), true);
setDisplay (getY2ZeroLine(), true);
setDualAxisSplitPosition (50);
setFontStyle (getY2Title(), 2);
setGraphType (21);
setTextJustVert (getY2Title(), 0);
setTextString (getY2Title(), "Y2 AXIS");

getY2TitleBox()

This method returns the object ID of the Y2-axis title box.

SYNTAX:

IdentObj getY2TitleBox()

EXAMPLE:

setGraphType (28); 
setY1TitleString ("Y1 Axis Title");
setY2TitleString ("Y2 Axis Title");
setDisplay (getY2TitleBox(), true);
setFillColor (getY2TitleBox(), new Color (255, 0, 0));
setSubtitleDisplay (false);

getY2ZeroLine()

This method returns the object ID of the Y2-axis zero line.

SYNTAX:

IdentObj getY2ZeroLine();

EXAMPLE:

setGraphType (21);
setDisplay (getY2ZeroLine(), true);
setLineWidth (getY2ZeroLine(), 8);

getY3AltFmtFrame()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y3-Axis frame. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y3-Axis frame.

SYNTAX:

IdentObj getY3AltFmtFrame();
IdentObj getY3AltFmtFrame(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setUseSampleData (false);
setDepthRadius (0);
setData (0,0,.5);
setData (0,1,1);
setData (0,2,2);
setData (0,3,3);
setData (1,0,10);
setData (1,1,11);
setData (1,2,12);
setData (1,3,13);
setData (1,0,10);
setData (2,0,10);
setData (2,1,11);
setData (2,2,12);
setData (2,3,13);
setData (3,0,10);
setData (3,1,11);
setData (3,2,12);
setData (3,3,13);
setData (4,0,10);
setData (4,1,11);
setData (4,2,12);
setData (4,3,13);
setDataRangeToExtent();
setGraphType (105);
setAxisAssignment (1,1);
setAxisAssignment (2,2);
setAxisAssignment (3,3);
setAxisAssignment (4,4);
setY1TitleString ("Y1 Axis");
setY2TitleString ("Y2 Axis");
setTextString (getY3Title(), "Y3 Axis");
setTextString (getY4Title(), "Y4 Axis");
setTextString (getY5Title(), "Y5 Axis");
setAlignMultiYBars (true);
setDisplay(getY3AltFmtFrame(), true); 
setAltFmtFrameNumColors(getY3AltFmtFrame(), 2); 
setAltFmtFrameSeparator(getY3AltFmtFrame(0), 12.0); 
setDisplay(getY3AltFmtFrame(0), true); 
setDisplay(getY3AltFmtFrame(1), true); 
setFillColor(getY3AltFmtFrame(0), new Color(255,0,0)); 
setFillColor(getY3AltFmtFrame(1), new Color(255,255,0));

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY3AltFmtLabel()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y3-Axis labels. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y3-Axis labels.

SYNTAX:

IdentObj getY3AltFmtLabel();
IdentObj getY3AltFmtLabel(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getY3AltFmtFrame(), true); 
setAltFmtFrameNumColors(getY3AltFmtFrame(), 2); 
setAltFmtFrameSeparator(getY3AltFmtFrame(0), 12.0); 
setDisplay(getY3AltFmtFrame(0), true); 
setDisplay(getY3AltFmtFrame(1), true); 
setFillColor(getY3AltFmtFrame(0), new Color(255,0,0)); 
setFillColor(getY3AltFmtFrame(1), new Color(255,255,0));
setDisplay(getY3AltFmtLabel(), true);
setTextString(getY3AltFmtLabel(1), "Label Section 0");
setFillColor(getY3AltFmtLabel(1), new Color(0,0,255));

NOTES:

See getY3AltFmtFrame() for the data that was used to generate this graph.

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY3Axis()

This method returns the object ID of the Y3 axis.

SYNTAX:

IdentObj getY3Axis()

EXAMPLE:

setGraphType (105);
setAxisDescending (getY3Axis(), true);

getY3AxisLine()

This method returns the object ID of the Y3-axis base line.

SYNTAX:

IdentObj getY3AxisLine()

EXAMPLE:

setGraphType (105);
setAxisDescending (getY3Axis(), true);
setLineWidth (getY3AxisLine(), 5);
setFillColor (getY3AxisLine(), new Color (255, 0, 0));

getY3Label()

This method returns the object ID of labels on the Y3-axis.

SYNTAX:

IdentObj getY3Label()

EXAMPLE:

setGraphType (105);
setFontStyle (getY3Label(), 6);
setFillColor (getY3Label(), new Color (255, 0, 0));

getY3MajorGrid()

This method returns the object ID of the Y3-axis major grid lines.

SYNTAX:

IdentObj getY3MajorGrid()

EXAMPLE:

setGraphType (105);
setLineWidth (getY3MajorGrid(), 2);
setFillColor (getY3MajorGrid(), new Color (255, 0, 0));

getY3MajorTick()

This method returns the object ID of major tick marks on the Y3-axis in a 5Y-Axis chart. The setDisplay() method must be used to enable and show this object.

SYNTAX:

IdentObj getY3MajorTick()

EXAMPLE:

setGraphType (105);
setDisplay (getY3MajorGrid(), false);
setDisplay (getY3MinorGrid(), false);
setDisplay (getY3MajorTick(), true);
setTickLength (getY3MajorTick(), 1000);
setBorderColor (getY3MajorTick(), new Color (255, 0, 0));

getY3MinorGrid()

This method returns the object ID of the Y3-axis minor grid lines.

SYNTAX:

IdentObj getY3MinorGrid()

EXAMPLE:

setGraphType (105);
setLineWidth (getY3MinorGrid(), 2);
setFillColor (getY3MinorGrid(), new Color (255, 0, 0));

getY3MinorTick()

This method returns the object ID of minor tick marks on the Y3-axis in a 5Y-Axis chart. The setDisplay() method must be used to enable and show this object.

SYNTAX:

IdentObj getY3MinorTick()

EXAMPLE:

setGraphType (105);
setDisplay (getY3MajorGrid(), false);
setDisplay (getY3MinorGrid(), false);
setDisplay (getY3MinorTick(), true);
setTickLength (getY3MinorTick(), 1000);
setBorderColor (getY3MinorTick(), new Color (255, 0, 0));

getY3Title()

This method returns the object ID of the Y3-axis title.

SYNTAX:

IdentObj getY3Title()

EXAMPLE:

setGraphType (105);
setY1TitleString ("Y1 Axis");
setY2TitleString ("Y2 Axis");
setTextString (getY3Title(), "Y3 Axis");
setTextString (getY4Title(), "Y4 Axis");
setTextString (getY5Title(), "Y5 Axis");
setFontStyle (getY3Title(), 7);
setFillColor (getY3Title(), new Color (255, 0, 0));

getY3TitleBox()

This method returns the object ID of the title box on a chart with an Y3 axis.

SYNTAX:

IdentObj getY3TitleBox()

EXAMPLE:

setGraphType (105);
setTitleString ("5Y-Axis Chart");
setY1TitleString ("Y1 Axis");
setY2TitleString ("Y2 Axis");
setTextString (getY3Title(), "Y3 Axis");
setTextString (getY4Title(), "Y4 Axis");
setTextString (getY5Title(), "Y5 Axis");
setFontStyle (getY3Title(), 7);
setFillColor (getY3Title(), new Color (255, 0, 0));
setDisplay (getY3TitleBox(), true);
setBorderColor (getY3TitleBox(), new Color (0, 0, 255));

getY3ZeroLine()

This method returns the object ID of the Y3-axis zero line.

SYNTAX:

IdentObj getY3ZeroLine()

EXAMPLE:

setGraphType (105);
setLineWidth (getY3ZeroLine(), 2);
setFillColor (getY3ZeroLine(), new Color (255, 0, 0));
setDisplay (getY3ZeroLine(), true);

getY4AltFmtFrame()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y4-Axis frame. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y4-Axis frame.

SYNTAX:

IdentObj getY4AltFmtFrame();
IdentObj getY4AltFmtFrame(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getY4AltFmtFrame(), true); 
setAltFmtFrameNumColors(getY4AltFmtFrame(), 2); 
setAltFmtFrameSeparator(getY4AltFmtFrame(0), 12.0); 
setDisplay(getY4AltFmtFrame(0), true); 
setDisplay(getY4AltFmtFrame(1), true); 
setFillColor(getY4AltFmtFrame(0), new Color(255,0,255)); 
setFillColor(getY4AltFmtFrame(1), new Color(0,255,0));

NOTES:

See getY3AltFmtFrame() for the data that was used to generate this graph.

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY4AltFmtLabel()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y4-Axis labels. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y4-Axis labels.

SYNTAX:

IdentObj getY4AltFmtLabel();
IdentObj getY4AltFmtLabel(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setAltFmtFrameNumColors(getY4AltFmtFrame(), 2); 
setAltFmtFrameSeparator(getY4AltFmtFrame(0), 12.0); 
setDisplay(getY4AltFmtFrame(0), true); 
setDisplay(getY4AltFmtFrame(1), true); 
setFillColor(getY4AltFmtFrame(0), new Color(255,0,255)); 
setFillColor(getY4AltFmtFrame(1), new Color(0,255,0));
setDisplay(getY4AltFmtLabel(), true);
setTextString(getY4AltFmtLabel(1), "Label Section 0");
setFillColor(getY4AltFmtLabel(1), new Color(0,0,255));

NOTES:

See getY3AltFmtFrame() for the data that was used to generate this graph.

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY4Axis()

This method returns the object ID of the Y4 axis.

SYNTAX:

IdentObj getY4Axis()

EXAMPLE:

setGraphType (105);
setAxisDescending (getY4Axis(), true);

getY4AxisLine()

This method returns the object ID of the Y4-axis base line.

SYNTAX:

IdentObj getY4AxisLine()

EXAMPLE:

setGraphType (105);
setLineWidth (getY4AxisLine(), 2);
setFillColor (getY4AxisLine(), new Color (255, 0, 0));

getY4Label()

This method returns the object ID of labels on the Y4-axis.

SYNTAX:

IdentObj getY4Label()

EXAMPLE:

setGraphType (105);
setFontStyle (getY4Label(), 6);
setFillColor (getY4Label(), new Color (255, 0, 0));

getY4MajorGrid()

This method returns the object ID of the Y4-axis major grid lines.

SYNTAX:

IdentObj getY4MajorGrid()

EXAMPLE:

setGraphType (105);
setLineWidth (getY4MajorGrid(), 2);
setFillColor (getY4MajorGrid(), new Color (255, 0, 0));

getY4MajorTick()

This method returns the object ID of major tick marks on the Y4-axis in a 5Y-Axis chart. The setDisplay() method must be used to enable and show this object.

SYNTAX:

IdentObj getY4MajorTick()

EXAMPLE:

setGraphType (105);
setDisplay (getY4MajorGrid(), false);
setDisplay (getY4MinorGrid(), false);
setDisplay (getY4MajorTick(), true);
setTickLength (getY4MajorTick(), 1000);
setBorderColor (getY4MajorTick(), new Color (255, 0, 0));

getY4MinorGrid()

This method returns the object ID of the Y4-axis minor grid lines.

SYNTAX:

IdentObj getY4MinorGrid()

EXAMPLE:

setGraphType (105);
setLineWidth (getY4MinorGrid(), 2);
setFillColor (getY4MinorGrid(), new Color (255, 0, 0));

getY4MinorTick()

This method returns the object ID of minor tick marks on the Y4-axis in a 5Y-Axis chart. The setDisplay() method must be used to enable and show this object.

SYNTAX:

IdentObj getY4MinorTick()

EXAMPLE:

setGraphType (105);
setDisplay (getY4MajorGrid(), false);
setDisplay (getY4MinorGrid(), false);
setDisplay (getY4MinorTick(), true);
setTickLength (getY4MinorTick(), 1000);
setBorderColor (getY4MinorTick(), new Color (255, 0, 0));

getY4Title()

This method returns the object ID of the Y4-axis title.

SYNTAX:

IdentObj getY4Title()

EXAMPLE:

setGraphType (105);
setY1TitleString ("Y1 Axis");
setY2TitleString ("Y2 Axis");
setTextString (getY3Title(), "Y3 Axis");
setTextString (getY4Title(), "Y4 Axis");
setTextString (getY5Title(), "Y5 Axis");
setFontStyle (getY4Title(), 7);
setFillColor (getY4Title(), new Color (255, 0, 0));

getY4TitleBox()

This method returns the object ID of the title box on a chart with an Y4 axis.

SYNTAX:

IdentObj getY4TitleBox()

EXAMPLE:

setGraphType (105);
setTitleString ("5Y-Axis Chart");
setY1TitleString ("Y1 Axis");
setY2TitleString ("Y2 Axis");
setTextString (getY3Title(), "Y3 Axis");
setTextString (getY4Title(), "Y4 Axis");
setTextString (getY5Title(), "Y5 Axis");
setFontStyle (getY4Title(), 7);
setFillColor (getY4Title(), new Color (255, 0, 0));
setBorderColor (getY4TitleBox(), new Color (0, 0, 255));
setDisplay (getY4TitleBox(), true);

getY4ZeroLine()

This method returns the object ID of the Y4-axis zero line.

SYNTAX:

IdentObj getY4ZeroLine()

EXAMPLE:

setGraphType (105);
setLineWidth (getY4ZeroLine(), 2);
setFillColor (getY4ZeroLine(), new Color (255, 0, 0));
setDisplay (getY4ZeroLine(), true);

getY5AltFmtFrame()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y5-Axis frame. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y5-Axis frame.

SYNTAX:

IdentObj getY5AltFmtFrame();
IdentObj getY5AltFmtFrame(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getY5AltFmtFrame(), true); 
setAltFmtFrameNumColors(getY5AltFmtFrame(), 2); 
setAltFmtFrameSeparator(getY5AltFmtFrame(0), 12.0); 
setDisplay(getY5AltFmtFrame(0), true); 
setDisplay(getY5AltFmtFrame(1), true); 
setFillColor(getY5AltFmtFrame(0), new Color(255,0,255)); 
setFillColor(getY5AltFmtFrame(1), new Color(0,255,0));

NOTES:

See getY3AltFmtFrame() for the data that was used to generate this graph.

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY5AltFmtLabel()

If nIndex is not specified, this method returns the object ID of the alternate formatted Y5-Axis labels. If nIndex is specified, this method returns the object ID of a section of the alternate formatted Y5-Axis labels.

SYNTAX:

IdentObj getY5AltFmtLabel();
IdentObj getY5AltFmtLabel(int nIndex);

INPUT:

nIndex; Alternate formatted frame section number (0...100). setAltFmtFrameNumColors() defines the maximum number of sections on a given axis.

EXAMPLE:

setDisplay(getY5AltFmtFrame(), true); 
setAltFmtFrameNumColors(getY5AltFmtFrame(), 2); 
setAltFmtFrameSeparator(getY5AltFmtFrame(0), 12.0); 
setDisplay(getY5AltFmtFrame(0), true); 
setDisplay(getY5AltFmtFrame(1), true); 
setFillColor(getY5AltFmtFrame(0), new Color(255,0,255)); 
setFillColor(getY5AltFmtFrame(1), new Color(0,255,0));
setDisplay(getY5AltFmtLabel(), true);
setTextString(getY5AltFmtLabel(1), "Label Section 0");
setFillColor(getY5AltFmtLabel(1), new Color(0,0,255));

NOTES:

See getY3AltFmtFrame() for the data that was used to generate this graph.

ALSO SEE:

setAltFmtFrameNumColors(), setAltFmtFrameSeparator(), Alternate Formatting in the Perspective for Java Programmer's Manual.

getY5Axis()

This method returns the object ID of the Y5 axis.

SYNTAX:

IdentObj getY5Axis()

EXAMPLE:

setGraphType (105);
setAxisDescending (getY5Axis(), true);

getY5AxisLine()

This method returns the object ID of the Y5-axis base line.

SYNTAX:

IdentObj getY5AxisLine()

EXAMPLE:

setGraphType (105);
setLineWidth (getY5AxisLine(), 2);
setFillColor (getY5AxisLine(), new Color (255, 0, 0));

getY5Label()

This method returns the object ID of labels on the Y5-axis.

SYNTAX:

IdentObj getY5Label()

EXAMPLE:

setGraphType (105);
setFontStyle (getY5Label(), 6);
setFillColor (getY5Label(), new Color (255, 0, 0));

getY5MajorGrid()

This method returns the object ID of the Y5-axis major grid lines.

SYNTAX:

IdentObj getY5MajorGrid()

EXAMPLE:

setGraphType (105);
setLineWidth (getY5MajorGrid(), 2);
setFillColor (getY5MajorGrid(), new Color (255, 0, 0));

getY5MajorTick()

This method returns the object ID of major tick marks on the Y5-axis in a 5Y-Axis chart. The setDisplay() method must be used to enable and show this object.

SYNTAX:

IdentObj getY5MajorTick()

EXAMPLE:

setGraphType (105);
setDisplay (getY5MajorGrid(), false);
setDisplay (getY5MinorGrid(), false);
setDisplay (getY5MajorTick(), true);
setTickLength (getY5MajorTick(), 1000);
setBorderColor (getY5MajorTick(), new Color (255, 0, 0));

getY5MinorGrid()

This method returns the object ID of the Y5-axis minor grid lines.

SYNTAX:

IdentObj getY5MinorGrid()

EXAMPLE:

setGraphType (105);
setLineWidth (getY5MinorGrid(), 2);
setFillColor (getY5MinorGrid(), new Color (255, 0, 0));

getY5MinorTick()

This method returns the object ID of minor tick marks on the Y5-axis in a 5Y-Axis chart. The setDisplay() method must be used to enable and show this object.

SYNTAX:

IdentObj getY5MinorTick()

EXAMPLE:

setGraphType (105);
setDisplay (getY5MajorGrid(), false);
setDisplay (getY5MinorGrid(), false);
setDisplay (getY5MinorTick(), true);
setTickLength (getY5MinorTick(), 1000);
setBorderColor (getY5MinorTick(), new Color (255, 0, 0));

getY5Title()

This method returns the object ID of the Y5-axis title.

SYNTAX:

IdentObj getY5Title()

EXAMPLE:

setGraphType (105);
setTitleString ("5Y-Axis Chart");
setY1TitleString ("Y1 Axis");
setY2TitleString ("Y2 Axis");
setTextString (getY3Title(), "Y3 Axis");
setTextString (getY4Title(), "Y4 Axis");
setTextString (getY5Title(), "Y5 Axis");
setFontStyle (getY5Title(), 7);
setFillColor (getY5Title(), new Color (255, 0, 0));

getY5TitleBox()

This method returns the object ID of the Y5-axis title box.

SYNTAX:

IdentObj getY5TitleBox()

EXAMPLE:

setGraphType (105);
setTitleString ("5Y-Axis Chart");
setY1TitleString ("Y1 Axis");
setY2TitleString ("Y2 Axis");
setTextString (getY3Title(), "Y3 Axis");
setTextString (getY4Title(), "Y4 Axis");
setTextString (getY5Title(), "Y5 Axis");
setFontStyle (getY5Title(), 7);
setFillColor (getY5Title(), new Color (255, 0, 0));
setBorderColor (getY5TitleBox(), new Color (0, 0, 255));
setDisplay (getY5TitleBox(), true);

getY5ZeroLine()

This method returns the object ID of the Y5-axis zero line.

SYNTAX:

IdentObj getY5ZeroLine()

EXAMPLE:

setGraphType (105);
setLineWidth (getY5ZeroLine(), 5);
setFillColor (getY5ZeroLine(), new Color (255, 0, 0));
setY5ZeroLineDisplay (true);