Chapter 9.
Methods that Get an Object ID
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: a series number |
g: a group number |
|
Return: |
IdentObj: Object ID of the area riser |
Example: |
perspective1.setDepthRadius(0); |
|
|
Also See: |
|
This method returns the object ID of the bottom of an area riser. |
|
Syntax: |
IdentObj getAreaRiserBottom(); |
Input: |
None |
Return: |
IdentObj: Object ID of the bottom of an area riser |
Also See: |
|
This method returns the object ID of the top of an area riser. |
|
Syntax: |
IdentObj getAreaRiserTop(); |
Input: |
None |
Return: |
IdentObj: Object ID of the top of an area riser |
Also See: |
|
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: a series number |
Input: |
g: a group number |
Return: |
IdentObj: Object ID of the bar riser |
Example: |
perspective1.setDepthRadius(0); |
|
|
Also See: |
|
This method returns the object ID of the bottom of a bar riser. |
|
Syntax: |
IdentObj getBarRiserBottom(); |
Input: |
None |
Return: |
IdentObj: Object ID of the bottom of a bar riser |
Also See: |
|
This method returns the object ID of the side of a bar riser. |
|
Syntax: |
IdentObj getBarRiserSide(); |
Input: |
None |
Return: |
IdentObj: Object ID of the top of a bar riser |
Also See: |
|
This method returns the object ID of the background area of the graph. |
|
Syntax: |
IdentObj getChartBackground(); |
Input: |
None |
Return: |
IdentObj: Object ID of the background area |
Example: |
perspective1.setViewableGroups(3); |
|
|
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 IdentObj 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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the color-by-height object |
Example: |
perspective1.setGraphType(12); |
|
|
Also See: |
setGradientNumPins(), setGradientPinLeftColor(), setGradientPinPosition(), |
This method returns the object ID of the cube floor in a 3D chart. |
|
Syntax: |
IdentObj getCubeFloor(); |
Input: |
None |
Return: |
IdentObj: Object ID of the 3D cube floor |
Example: |
perspective1.setGraphType(14); |
|
|
Also See: |
|
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of X-axis grid lines on a 3D cube floor |
Example: |
perspective1.setGraphType(4); |
|
|
Also See: |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of Z-axis grid lines on a 3D cube floor |
Example: |
perspective1.setGraphType(4); |
|
|
Also See: |
|
This method returns the object ID of the left wall of the cube in a 3D graph. |
|
Syntax: |
IdentObj getCubeLeftWall(); |
Input: |
None |
Return: |
IdentObj: Object ID of the 3D cube left wall |
Example: |
perspective1.setGraphType(4); |
|
|
Also See: |
|
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of Y-axis grid lines on the 3D cube left wall |
Example: |
perspective1.setGraphType(4); |
|
|
Also See: |
|
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of Z-axis grid lines on the 3D cube left wall |
Example: |
perspective1.setGraphType(4); |
|
|
Also See: |
|
This method returns the object ID of the right wall of the cube in a 3D graph. |
|
Syntax: |
IdentObj getCubeRightWall(); |
Input: |
None |
Return: |
IdentObj: Object ID of the 3D cube right wall |
Example: |
perspective1.setGraphType(4); |
|
|
Also See: |
|
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of X-axis grid lines on a 3D cube right wall |
Example: |
perspective1.setGraphType(4); |
|
|
Also See: |
|
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of Y-axis grid lines on a 3D cube right wall |
Example: |
perspective1.setGraphType(4); |
|
|
Also See: |
|
This method returns the object ID of the face of risers in a 3D graph. |
|
Syntax: |
IdentObj getCubeRiserFace(); |
Input: |
None |
Return: |
IdentObj: Object ID of the face of risers |
Also See: |
getCubeRiserGridX(), getCubeRiserGridY(), |
This method returns the object ID of X-axis grid lines that may be displayed on the risers in a 3D graph. |
|
Syntax: |
IdentObj getCubeRiserGridX(); |
Input: |
None |
Return: |
IdentObj: Object ID of X-axis grid lines on 3D risers |
Example: |
perspective1.setGraphType(12); |
|
|
Also See: |
getCubeRiserFace(), getCubeRiserGridY(), |
This method returns the object ID of y-axis grid lines that may be displayed on the risers in a 3D graph. |
|
Syntax: |
IdentObj getCubeRiserGridY(); |
Input: |
None |
Return: |
IdentObj: Object ID of Y-axis grid lines on 3D risers |
Example: |
perspective1.setGraphType(1); |
|
|
Also See: |
getCubeRiserFace(), getCubeRiserGridX(), |
This method returns the object ID of Z-axis grid lines that may be displayed on the risers in a 3D graph. |
|
Syntax: |
IdentObj getCubeRiserGridZ(); |
Input: |
None |
Return: |
IdentObj: Object ID of Z-axis grid lines on 3D risers |
Example: |
perspective1.setGraphType(12); |
|
|
Also See: |
getCubeRiserFace(), getCubeRiserGridX(), |
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() |
Input: |
None |
Return: |
IdentObj; The object ID of curve fit correlation text |
Also See: |
getCurveFitEquationText(), getCurveFitType(), |
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 |
Return: |
IdentObj; The object ID of curve fit equation text |
Also See: |
CurveFitEquationDisplay, getCurveFitCorrelationText(), |
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 |
Return: |
IdentObj; The object ID of curve fit line |
Also See: |
|
This method returns the object ID of a chart's data text. |
|
Syntax: |
IdentObj getDataText(); |
IdentObj getDataText(int s, int g); |
|
Input: |
s: a series number |
g: a group number |
|
Return: |
IdentObj: Object ID of data text |
Example: |
perspective1.setDisplay(perspective1.getDataText(), true); |
|
|
Also See: |
|
|
This method can be used to get 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: a series number |
|
g: a group number |
Return: |
IdentObj: Object ID of the exceptional riser at series(s)./group(g) |
Example: |
perspective1.setExceptionalRiser(2,1); |
|
|
Also See: |
getExceptionalRisers(), setExceptionalRiser(), |
|
|
This method returns the object ID of the chart footnote object. |
|
Syntax: |
IdentObj getFootnote(); |
Input: |
None |
Return: |
IdentObj: Object ID of the chart footnote |
Example: |
perspective1.setAutofit(perspective1.getFootnote(),false); |
|
|
Also See: |
getTitle(), getSubtitle() |
getFrame()
This method returns the object ID of the chart frame. |
|
Syntax: |
IdentObj getFrame(); |
Input: |
None |
Return: |
IdentObj: Object ID of the chart frame |
Example: |
perspective1.setDisplay( |
|
|
Also See: |
|
This method returns the object ID of the bottom of the chart frame. |
|
Syntax: |
IdentObj getFrameBottom(); |
Input: |
None |
Return: |
IdentObj: Object ID of the bottom of the chart frame |
Also See: |
getFrame(), getFrameSeparator(), getFrameSide() |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the chart frame separator |
Example: |
perspective1.setDataRange(1,1,3,3); |
|
|
Also See: |
getFrame(), getFrameBottom(), getFrameSide() |
This method returns the object ID of the chart frame side. |
|
Syntax: |
IdentObj getFrameSide(); |
Input: |
None |
Return: |
IdentObj: Object ID of the chart frame side |
Also See: |
getFrame(), getFrameBottom(), getFrameSeparator() |
This method returns the "global IdentObj" which can be passed to any method that takes an IdentObj (e.g., getGradientDirection()). This method is useful for setting a global default value for for something like color or line width. |
|
Syntax: |
IdentObj getGlobal(); |
Input: |
None |
Return: |
IdentObj: kGLOBAL |
Notes: |
This method is not completely implemented in this release of Perspective. |
getGroup()
This method returns the object ID of group number nGroup. |
|
Syntax: |
IdentObj getGroup(int nGroup); |
Input: |
nGroup: Any valid group number. |
Return: |
IdentObj: Object ID of group nGroup |
Also See: |
getGroupLabel(), getSeries(), getSeriesGroup() |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the group data scroller bar |
Example: |
perspective1.setAutofit( |
|
|
Also See: |
getGroupScrollerEditLeft(), getGroupScrollerEditBox, getGroupScrollerEditRight(), getGroupScrollerEditThumb(), getGroupScrollerThumb(), DataScrollerPresenceGroups |
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() |
Input: |
None |
Return: |
IdentObj: the object ID of the group scroller edit box |
Example: |
perspective1.setViewableGroups(3); |
|
|
Also See: |
getGroupScroller(), getGroupScrollerEditLeft(), getGroupScrollerEditRight(), getGroupScrollerEditThumb(), getGroupScrollerThumb(), DataScrollerPresenceGroups |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the group data scroller left edit bar |
Example: |
See getGroupScroller() |
Also See: |
getGroupScroller(), getGroupScrollerEditBox(), |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the group data scroller right edit bar |
Example: |
See getGroupScroller() |
Also See: |
getGroupScroller(),getGroupScrollerEditBox(), getGroupScrollerEditLeft(), getGroupScrollerEditThumb(), getGroupScrollerThumb(), DataScrollerPresenceGroups |
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 scroller bar that shows three numbers representing the total groups, viewable groups, and group offset. |
|
Syntax: |
IdentObj getGroupScrollerEditThumb(); |
Input: |
None |
Return: |
IdentObj: Object ID of the group data scroller bar edit thumb |
Example: |
See getGroupScroller() |
Also See: |
getGroupScrollerEditLeft(),getGroupScrollerEditBox(), getGroupScrollerEditRight(), getGroupScroller(), getGroupScrollerThumb(), DataScrollerPresenceGroups |
This method returns the object ID of the group scroller edit box. The group scroller bar is enabled and displayed with the DataScrollerPresenceGroups property. The thumb is the movable area of the scroller bar that can be used to adjust the group offset. |
|
Syntax: |
IdentObj getGroupScrollerThumb(); |
Input: |
None |
Return: |
IdentObj: Object ID of the group scroller bar thumb |
Example: |
perspective1.setViewableGroups(3); |
|
|
Also See: |
getGroupScrollerEditLeft(),getGroupScrollerEditBox(), |
This method returns the object ID of the risers in a histrogram chart. |
|
Syntax: |
IdentObj getHistogramRiser(); |
Input: |
None |
Return: |
IdentObj: Object ID of risers in a histogram chart |
Example: |
perspective1.setFillColor( |
|
|
This method returns the object ID of the chart's legend area. |
|
Syntax: |
IdentObj getLegendArea(); |
Input: |
None |
Return: |
IdentObj: Object ID of the chart's legend area |
Example: |
perspective1.setViewableSeries(3); |
|
|
Also See: |
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 |
Return: |
IdentObj: Object ID of markers in the chart's legend area |
Also See: |
|
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 |
Return: |
IdentObj: Object ID of text in the chart's legend area |
Example: |
perspective1.setFontStyle(perspective1.getLegendText(),2); |
|
|
Also See: |
|
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: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of markers in a line chart |
Also See: |
|
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: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of risers in a line chart |
Example: |
perspective1.setGraphType(41); |
Also See: |
|
This method returns the object ID of side of risers in a line chart. |
|
Syntax: |
IdentObj getLineRiserSide(); |
Input: |
None |
Return: |
IdentObj: Object ID of the sides of riser in a line chart |
Also See: |
getLineMarker(), getLineRiser(), getLineRiserTop() |
This method returns the object ID of the top of risers in a line chart. |
|
Syntax: |
IdentObj getLineRiserTop(); |
Input: |
None |
Return: |
IdentObj: Object ID of top of risers in a line chart |
Also See: |
getNestedO1Label0...8
These methods are used to get 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() |
|
Input: |
None |
Return: |
IdentObj: Object ID of a nested O1 label |
Example: |
perspective1.setDepthRadius(0); |
|
|
Also See: |
|
This method gets the object ID of the line that can be drawn below group axis nested labels. |
|
Syntax: |
IdentObj getNestedO1LabelLine() |
Input: |
None |
Return: |
IdentObj: The line that is drawn below nested O1-axis labels |
Example: |
perspective1.setDepthAngle(0); |
|
|
Also See: |
This method returns the object ID of the primary ordinal (O1) axis. |
|
Syntax: |
IdentObj getO1Axis(); |
Input: |
None |
Return: |
IdentObj: Object ID of the O1-axis |
Example: |
perspective1.setAxisSide(perspective1.getO1Axis(),2); |
|
|
Also See: |
getO1AxisLine(), getO1Label(), getO1MajorGrid(), getO1MinorGrid, getO1Title() |
This method returns the object ID of the primary ordinal (O1) axis base line. |
|
Syntax: |
IdentObj getO1AxisLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the O1-axis base line |
Example: |
perspective1.setViewableSeries(3); |
|
|
Also See: |
getO1Axis(), getO1Label(), getO1MajorGrid(), getO1MinorGrid, |
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 |
Return: |
IdentObj: Object ID of the O1-axis labels |
Example: |
perspective1.setViewableSeries(3); |
|
|
Also See: |
getO1Axis(), getO1AxisLine(), getO1MajorGrid(), getO1MinorGrid, getO1Title() |
This method returns the object ID of the primary ordinal (O1) axis grid lines. |
|
Syntax: |
IdentObj getO1MajorGrid(); |
Input: |
None |
Return: |
IdentObj: Object ID of the O1-axis major grid lines |
Example: |
perspective1.setDataRange(0,0,2,2); |
|
|
Also See: |
getO1Axis(), getO1AxisLine(), getO1Label(), getO1MinorGrid, getO1Title() |
This method returns the object ID of the primary ordinal (O1) axis minor grid lines. |
|
Syntax: |
IdentObj getO1MinorGrid(); |
Input: |
None |
Return: |
IdentObj: Object ID of the O1-axis minor grid lines |
Example: |
perspective1.setViewableSeries(3); |
|
|
Also See: |
getO1Axis(), getO1AxisLine(), getO1Label(), getO1MajorGrid(), |
This method returns the object ID of the primary ordinal (O1) axis title. |
|
Syntax: |
IdentObj getO1Title(); |
Input: |
None |
Return: |
IdentObj: Object ID of the O1-axis title |
Example: |
perspective1.setViewableSeries(3); |
|
|
Also See: |
getO1Axis(), getO1AxisLine(), getO1Label(), getO1MajorGrid(), getO1MinorGrid |
This method returns the object ID of the secondary ordinal (O2) axis labels. |
|
Syntax: |
IdentObj getO2Label(); |
Input: |
None |
Return: |
IdentObj: Object ID of the O2-axis labels |
Also See: |
|
This method returns the object ID of the secondary ordinal (O2) axis title. |
|
Syntax: |
IdentObj getO2Title(); |
Input: |
None |
Return: |
IdentObj: Object ID of the O2-axis title |
Example: |
perspective1.setDataRange(0,0,3,3); |
|
|
Also See: |
|
This method can be used to get the object ID of the bottom line that connects the bar to a series in a pie-bar (donut) chart. |
|
Syntax: |
IdentObj getPieBarConnectLineBottom(); |
Input: |
None |
Return: |
IdentObj: Object ID of bottom connecting line in a Pie Bar Chart |
Notes: |
This object is only present in the chart if the GraphType property is set to 93 (Pie-Bar chart). |
Also See: |
|
This method can be used to get the object ID of the lines that connect the bar to a series in a pie-bar (donut) chart. |
|
Syntax: |
IdentObj getPieBarConnectLines(); |
Input: |
None |
Return: |
IdentObj: Object ID of Pie Bar Connecting Lines |
Example: |
perspective1.setGraphType(93); |
|
|
Notes: |
This object is only present in the chart if the GraphType property is set to 93 (Pie-Bar chart). |
Also See: |
|
This method can be used to get the object ID of the top line that connects the bar to a series in a pie-bar (donut) chart. |
|
Syntax: |
IdentObj getPieBarConnectLineTop(); |
Input: |
None |
Return: |
IdentObj: Object ID of top connecting line in a Pie Bar Chart |
Notes: |
This object is only present in the chart if the GraphType property is set to 93 (Pie-Bar chart). |
Also See: |
|
This method can be used to get the object ID of the riser in a pie-bar (donut) chart. |
|
Syntax: |
IdentObj getPieBarRiser(); |
Input: |
None |
Return: |
IdentObj: Object ID of a riser in a pie-bar chart |
Example: |
perspective1.setFillType( |
Notes: |
This object is only present in the chart if the GraphType property is set to 93 (Pie-Bar chart). |
This method can be used to get the object ID of a slice in a pie-bar (donut) chart. |
|
Syntax: |
IdentObj getPieBarSlice(); |
IdentObj getPieBarSlice (int s, int g); |
|
Input: |
s: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of a slice in a pie-bar chart |
Notes: |
This object is only present in the chart if the GraphType property is set to 93 (Pie-Bar chart). |
Also See: |
|
This method can be used to get the object ID of the slice crust in a pie-bar (donut) chart. |
|
Syntax: |
IdentObj getPieBarSliceCrust(); |
Input: |
None |
Return: |
IdentObj: Object ID of the crust in a pie-bar chart |
Notes: |
This object is only present in the chart if the GraphType property is set to 93 (Pie-Bar chart). |
Also See: |
|
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: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of feeler lines in a pie chart |
Example: |
perspective1.setGraphType(55); |
|
|
Also See: |
getPieFrame(), getPieLabel(), getPieRingLabel(), getPieSliceLabel() |
This method returns the object ID of the frame of a pie chart. |
|
Syntax: |
IdentObj getPieFrame(); |
Input: |
None |
Return: |
IdentObj: Object ID of pie chart frame |
Example: |
perspective1.setGraphType(55); |
Also See: |
getPieFeelerLine(), getPieLabel(), getPieRingLabel(), getPieSliceLabel() |
This method returns the object ID of groups labels that may appear in multiple pie charts. |
|
Syntax: |
IdentObj getPieLabel(); |
IdentObj getPieLabel(int g ); |
|
Input: |
g; Optional group number |
Return: |
IdentObj: Object ID of group labels in a multiple pie chart |
Also See: |
getPieFeelerLine(), getPieFrame(), getPieRingLabel(), getPieSliceLabel() |
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 |
Return: |
IdentObj: Object ID of labels in a ring pie chart |
Example: |
perspective1.setGraphType(56); |
|
|
Also See: |
getPieFeelerLine(), getPieFrame(), getPieLabel(), getPieSliceLabel() |
This method returns the object ID slice labels in a pie chart. |
|
Syntax: |
IdentObj getPieSliceLabel(); |
IdentObj getPieSliceLabel ( int s, int g); |
|
Input: |
s: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of slice labels in a pie chart |
Example: |
perspective1.setFontSizeVC( |
|
|
Also See: |
getPieFeelerLine(), getPieFrame(), getPieLabel(), getPieRingLabel() |
This method returns the object ID of the quadrant lines in a bubble chart. |
|
Syntax: |
IdentObj getQuadrantLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of quadrant lines in a bubble chart |
Example: |
perspective1.setGraphType(89); |
|
|
Also See: |
|
This method returns the object ID of the quadrant lines in a scatter chart. |
|
Syntax: |
IdentObj getScatterQuadrantLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of quadrant lines in a scatter chart |
Example: |
perspective1.setDisplay( |
|
|
This method returns the object ID of the first item in the selection list. |
|
Syntax: |
IdentObj getSelectionID(); |
Input: |
None |
Return: |
IdentObj = the object ID of the first item in the selection list (if any) |
Also See: |
getSelectionSize(), getSelectionBorderColor(), getSelectionFillColor(), getSelectionLineWidth() |
This method returns the object ID of the series specified by nSeries. |
|
Syntax: |
IdentObj getSeries(int nSeries); |
Input: |
nSeries: Any valid series number. |
Return: |
IdentObj: Object ID of series nSeries |
Example: |
perspective1.setDataRange(0,0,3,3); |
|
|
Also See: |
|
This method returns the object ID of the series associated with nSeries and nGroup. |
|
Syntax: |
IdentObj getSeriesGroup(int nSeries, int nGroup); |
Input: |
nSeries: Any valid series number |
nGroup: Any valid group number |
|
Return: |
IdentObj: Object ID of the series associated with nSeries and nGroup |
Example: |
perspective1.setDataRange(1,1,2,2); |
|
|
Also See: |
|
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the series data scroller bar |
Example: |
perspective1.setAutofit( |
Also See: |
getSeriesScrollerEditBox(), getSeriesScrollerEditLeft(), getSeriesScrollerEditRight(), getSeriesScrollerEditThumb(), getGroupScrollerThumb(), DataScrollerPresenceSeries |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the series scroller edit box. |
Also See: |
getSeriesScroller(), getSeriesScrollerEditLeft(), getSeriesScrollerEditRight(), getSeriesScrollerEditThumb(), getGroupScrollerThumb(), DataScrollerPresenceSeries |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Series data scroller left digit |
Example: |
perspective1.setAutofit( |
Also See: |
getSeriesScroller(), getSeriesScrollerEditBox(), getSeriesScrollerEditRight(), getSeriesScrollerEditThumb(), DataScrollerPresenceSeries |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Series data scroller right edit bar |
Example: |
perspective1.setAutofit( |
Also See: |
getSeriesScroller(), getSeriesScrollerEditBox(), getSeriesScrollerEditLeft(), getSeriesScrollerEditThumb(), DataScrollerPresenceSeries |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Series data scroller bar edit thumb |
Example: |
perspective1.setAutofit( |
Also See: |
getSeriesScroller(), getSeriesScrollerEditBox(), getSeriesScrollerEditLeft(), getSeriesScrollerEditRight(), DataScrollerPresenceSeries |
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(); |
Input: |
None |
Return: |
IdentObj: Object ID of the series scroller thumb. |
Also See: |
getSeriesScroller(), getSeriesScrollerEditBox(), getSeriesScrollerEditLeft(), getSeriesScrollerEditRight(), getSeriesScrollerEditThumb(), DataScrollerPresenceSeries |
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: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of a slice in a pie chart |
Also See: |
|
This method returns the object ID of the slice crust in a pie chart. |
|
Syntax: |
IdentObj getSliceCrust(); |
Input: |
None |
Return: |
IdentObj: Object ID of the slice crust in a pie chart |
Also See: |
getSlice(), getSliceRing() |
This method returns the object ID of a slice in a ring pie chart. |
|
Syntax: |
IdentObj getSliceRing(); |
Input: |
None |
Return: |
IdentObj: Object ID of a slice in a pie ring chart |
Also See: |
getSliceCrust(), getSlice() |
This method returns the object ID of the legend marker in a specral map. |
|
Syntax: |
IdentObj getSpectralLegendMarker(); |
IdentObj getSpectralLegendMarker(int i); |
|
Input: |
i: |
Return: |
IdentObj: Object ID of legend marker in a spectral map |
Also See: |
|
This method returns the object ID of the markers in a specral map. |
|
Syntax: |
IdentObj getSpectralMarker(); |
Input: |
None |
Return: |
IdentObj: Object ID of marker in a spectral map |
Also See: |
|
This method returns the object ID of the 52-week high line that may be displayed in a stock chart. |
|
Syntax: |
IdentObj getStock52WeekHighLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the 52-week high line in a stock chart |
Example: |
perspective1.setDisplay( |
|
|
Also See: |
getStock52WeekLowLine(), getStockCloseTick(), getStockFallingRiser(), getStockHighLine(), getStockLowerRiser(), getStockLowLine(), getStockMALine(), getStockOpenTick(), getStockRiser(), getStockRisingRiser(), getStockVolumeRiser() |
This method returns the object ID of the 52-week low line that may be displayed in a stock chart. |
|
Syntax: |
IdentObj getStock52WeekLowLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the 52-week low line in a stock chart |
Example: |
perspective1.setDisplay( |
|
|
Also See: |
getStock52WeekHighLine(), getStockCloseTick(), getStockFallingRiser(), getStockHighLine(), getStockLowerRiser(), getStockLowLine(), getStockMALine(), getStockOpenTick(), getStockRiser(), getStockRisingRiser(), getStockVolumeRiser() |
This method returns the object ID of the close ticks that may be displayed in a stock chart. |
|
Syntax: |
IdentObj getStockCloseTick(); |
IdentObj getStockCloseTick(int s, int g); |
|
Input: |
s: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of the close ticks in a stock chart |
Example: |
perspective1.setGraphType(76); |
|
|
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), |
This method returns the object ID of the falling riser that may be displayed in a stock chart. |
|
Syntax: |
IdentObj getStockFallingRiser(); |
IdentObj getStockFallingRiser(int s, int g); |
|
Input: |
s: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of the falling risers in a stock chart |
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), |
This method returns the object ID of the high line that may be displayed in a stock chart. |
|
Syntax: |
IdentObj getStockHighLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the high line in a stock chart |
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), |
This method returns the object ID of the lower risers that may be displayed in a stock chart. |
|
Syntax: |
IdentObj getStockLowerRiser(); |
Input: |
None |
Return: |
IdentObj: Object ID of the lower risers in a stock chart |
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), |
This method returns the object ID of the low line that may be displayed in a stock chart. |
|
Syntax: |
IdentObj getStockLowLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the low line in a stock chart |
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), getStockCloseTick(), getStockFallingRiser(), getStockHighLine(), getStockLowerRiser(), getStockMALine(), getStockOpenTick(), getStockRiser(), getStockRisingRiser(), getStockVolumeRiser() |
This method returns the object ID of the moving average line that may be displayed in a stock chart. |
|
Syntax: |
IdentObj getStockMALine(); |
IdentObj getStockMALine(int s, int g); |
|
Input: |
s: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of the moving average line in a stock chart |
Example: |
perspective1.setDisplay( |
|
|
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), getStockCloseTick(), getStockFallingRiser(), getStockHighLine(), getStockLowerRiser(), getStockLowLine(), getStockOpenTick(), getStockRiser(), getStockRisingRiser(), getStockVolumeRiser() |
This method returns the object ID of open ticks that may be displayed in a stock chart. |
|
Syntax: |
IdentObj getStockOpenTick(); |
IdentObj getStockOpenTick(int s, int g); |
|
Input: |
s: an optional series number |
g: an optional group number |
|
Input: |
None |
Return: |
IdentObj: Object ID of open ticks in a stock chart |
Example: |
perspective1.setGraphType(83); |
|
|
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), getStockCloseTick(), getStockFallingRiser(), getStockHighLine(), getStockLowerRiser(), getStockLowLine(), getStockMALine(), getStockRiser(), getStockRisingRiser(), getStockVolumeRiser() |
This method returns the object ID of risers in a stock chart. |
|
Syntax: |
IdentObj getStockRiser(); |
Input: |
None |
Return: |
IdentObj: Object ID of the risers in a stock chart |
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), getStockCloseTick(), getStockFallingRiser(), getStockHighLine(), getStockLowerRiser(), getStockLowLine(), getStockMALine(), getStockOpenTick(), getStockRisingRiser(), getStockVolumeRiser() |
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: an optional series number |
g: an optional group number |
|
Return: |
IdentObj: Object ID of rising risers in a stock chart |
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), getStockCloseTick(), getStockFallingRiser(), getStockHighLine(), getStockLowerRiser(), getStockLowLine(), getStockMALine(), getStockOpenTick(), getStockRiser(), 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 |
Return: |
IdentObj: Object ID of volume risers in a stock chart |
Example: |
perspective1.setFillColor( |
|
|
Also See: |
getStock52WeekHighLine(), getStock52WeekLowLine(), getStockCloseTick(), getStockFallingRiser(), getStockHighLine(), getStockLowerRiser(), getStockLowLine(), getStockMALine(), getStockOpenTick(), getStockRiser(), getStockRisingRiser() |
This method returns the object ID of the chart subtitle. |
|
Syntax: |
IdentObj getSubtitle(); |
Input: |
None |
Return: |
IdentObj: Object ID of chart subtitle |
Example: |
perspective1.setAutofit( |
Also See: |
getTitle() |
getTitle()
This method returns the object ID of the chart title. |
|
Syntax: |
IdentObj getTitle(); |
Input: |
None |
Return: |
IdentObj: Object ID of chart title |
Example: |
perspective1.setAutofit(perspective1.getTitle(),false); |
Also See: |
|
This method returns the object ID of the X1 axis. |
|
Syntax: |
IdentObj getX1Axis(); |
Input: |
None |
Return: |
IdentObj: Object ID of the X1-axis |
Example: |
perspective1.setDisplay( |
Also See: |
getX1AxisLine(), getX1Label(), getX1MajorGrid(), getX1MinorGrid, getX1Title() |
This method returns the object ID of the X1-axis base line. |
|
Syntax: |
IdentObj getX1AxisLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the X1-axis base line |
Example: |
perspective1.setDisplay( |
|
|
Also See: |
getX1Axis(), getX1Label(), getX1MajorGrid(), getX1MinorGrid, |
This method returns the object ID of labels on the X1-axis. |
|
Syntax: |
IdentObj getX1Label(); |
Input: |
None |
Example: |
perspective1.setX1ZeroLineDisplay(true); |
|
|
Return: |
IdentObj: Object ID of the X1-axis labels |
Also See: |
getX1Axis(), getX1AxisLine(), getX1MajorGrid(), getX1MinorGrid, getX1Title() |
This method returns the object ID of the X1-axis major grid lines. |
|
Syntax: |
IdentObj getX1MajorGrid(); |
Input: |
None |
Return: |
IdentObj: Object ID of the X1-axis major grid lines |
Example: |
perspective1.setGraphType(61); |
|
|
Also See: |
getX1Axis(), getX1AxisLine(), getX1Label(), getX1MinorGrid(), |
This method returns the object ID of the X1-axis minor grid lines. |
|
Syntax: |
IdentObj getX1MinorGrid(); |
Input: |
None |
Return: |
IdentObj: Object ID of the X1-axis minor grid lines |
Example: |
perspective1.setGraphType(61); |
|
|
Also See: |
getX1Axis(), getX1AxisLine(), getX1Label(), getX1MajorGrid(), |
This method returns the object ID of the X1-axis title. |
|
Syntax: |
IdentObj getX1Title(); |
Input: |
None |
Return: |
IdentObj: Object ID of the X1-axis title |
Example: |
perspective1.setDisplay( |
|
|
Also See: |
getX1Axis(), getX1AxisLine(), getX1Label(), getX1MajorGrid(), getX1MinorGrid() |
This method returns the object ID of the X1-axis zero line. |
|
Syntax: |
IdentObj getX1Title(); |
Input: |
None |
Return: |
IdentObj: Object ID of the X1-axis title |
Example: |
perspective1.setDisplay( |
|
|
Also See: |
getX1Axis(), getX1AxisLine(), getX1Label(), getX1MajorGrid(), getX1MinorGrid() |
This method returns the object ID of the Y1 axis. |
|
Syntax: |
IdentObj getY1Axis(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y1-axis |
Also See: |
getY1AxisLine(), getY1Label(), getY1MajorGrid(), getY1MinorGrid, getY1Title() |
This method returns the object ID of the Y1-axis base line. |
|
Syntax: |
IdentObj getY1AxisLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y1-axis base line |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY1Axis(), getY1Label(), getY1MajorGrid(), getY1MinorGrid(), getY1Title() |
This method returns the object ID of labels on the Y1-axis. |
|
Syntax: |
IdentObj getY1Label(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y1-axis labels |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY1Axis(), getY1AxisLine(), getY1MajorGrid(), getY1MinorGrid(), getY1Title() |
This method returns the object ID of the Y1-axis major grid lines. |
|
Syntax: |
IdentObj getY1MajorGrid(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y1-axis major grid lines |
Example: |
perspective1.setGraphType(61); |
|
|
Also See: |
getY1Axis(), getY1AxisLine(), getY1Label(), getY1MinorGrid(), |
This method returns the object ID of the Y1-axis minor grid lines. |
|
Syntax: |
IdentObj getY1MinorGrid(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y1-axis minor grid lines |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY1Axis(), getY1AxisLine(), getY1Label(), getY1MajorGrid(), |
This method returns the object ID of the Y1-axis title. |
|
Syntax: |
IdentObj getY1Title(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y1-axis title |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY1Axis(), getY1AxisLine(), getY1Label(), getY1MajorGrid(), getY1MinorGrid() |
This method returns the object ID of the Y1-axis zero line. |
|
Syntax: |
IdentObj getY1ZeroLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y1-axis zero line |
Example: |
perspective1.setDepthAngle(0); |
Also See: |
getY1Axis(), getY1AxisLine(), getY1Label(), getY1MajorGrid(), getY1MinorGrid() |
This method returns the object ID of the Y2 axis. |
|
Syntax: |
IdentObj getY2Axis(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y2-axis |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY2AxisLine(), getY2Label(), getY2MajorGrid(), getY2MinorGrid(), getY2Title() |
This method returns the object ID of the Y2-axis base line. |
|
Syntax: |
IdentObj getY2AxisLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y2-axis base line |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY2Axis(), getY2Label(), getY2MajorGrid(), getY2MinorGrid(), getY2Title() |
This method returns the object ID of labels on the Y2-axis. |
|
Syntax: |
IdentObj getY2Label(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y2-axis labels |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY2Axis(), getY2AxisLine(), getY2MajorGrid(), getY2MinorGrid(), getY2Title() |
This method returns the object ID of the Y2-axis major grid lines. |
|
Syntax: |
IdentObj getY2MajorGrid(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y2-axis major grid lines |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY2Axis(), getY2AxisLine(), getY2Label(), getY2MinorGrid(), |
This method returns the object ID of the Y2-axis minor grid lines. |
|
Syntax: |
IdentObj getY2MinorGrid(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y2-axis minor grid lines |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY2Axis(), getY2AxisLine(), getY2Label(), getY2MajorGrid(), |
This method returns the object ID of the Y2-axis title. |
|
Syntax: |
IdentObj getY2Title(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y2-axis title |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY2Axis(), getY2AxisLine(), getY2Label(), getY2MajorGrid(), getY2MinorGrid() |
This method returns the object ID of the Y2-axis zero line. |
|
Syntax: |
IdentObj getY2ZeroLine(); |
Input: |
None |
Return: |
IdentObj: Object ID of the Y2-axis zero line |
Example: |
perspective1.setDataRange(1,1,4,4); |
|
|
Also See: |
getY2Axis(), getY2AxisLine(), getY2Label(), getY2MajorGrid(), getY2MinorGrid() |