Getting Chart Information

getEffectiveColorMode(); Get Effective Color Mode
getEffectiveGroupOffset(); Get Effective Group Offset
getEffectiveSeriesOffset(); Get Effective Series Offset
getEffectiveViewableGroups(); Get Effective Viewable Groups
getEffectiveViewableSeries(); Get Effective Viewable Series
getHasGraphics2D(); Does the chart have 2D graphics?
getLegendMinWidth(); Get Legend Minimum Width
hasBarOrMarkerSeries(); Does the chart have a series drawn as a bar or marker?
isChart3DType(); Is Chart 3D Type?
isChartBipolar(); Is Chart Bi-Polar?
isChartBLAType(); Is Chart Bar/Line/Area Type?
isChartDualY(); Is Chart Dual-Y Axes?
isChartOrientHorz(); Is Chart Horizontal Orientation?
isChartPieType(); Is Chart Pie Type?
isChartScatter(); Is Chart Scatter Type?
isChartStockType(); Is Chart Stock Type?
isColorByGroup(); Is Chart Colored by Grup?
isColorByHeight(); Is Chart Colored by Height?
isExceptionalAllowed(); Is Exceptional Riser Allowed?
isGroupScrollerPresent(); Is Group Scroller Present?
isO1AxisPresent(); Is O1 Axis Present?
isO2AxisPresent(); Is O2 Axis Present?
isSeriesScrollerPresent(); Is Series Scroller Present?
isX1AxisPresent(); Is X1 Axis Present?
isY1AxisPresent(); Is Y1 Axis Present?
isY2AxisPresent(); Is Y2 Axis Present?
isZ1AxisPresent(); Is Z1 Axis Present?

getEffectiveColorMode()

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

SYNTAX:

int getEffectiveColorMode()

INPUT:

None

RETURN:

int; 0...2: 0 = Automatic. Use the group as the series if there is only one series. 3D Connected Series Ribbon and Areas are colored by series. 3D Group Ribbon and Areas are colored by group. 1 = Color by Series. 2 = Color by Group

ALSO SEE:

ColorMode

getEffectiveGroupOffset()

This method can be used to determine whether or not all groups in the data set are being imaged in the chart. It returns the effective group offset (i.e., the total number of groups in the data set minus the number of viewable groups). The number of viewable groups is set by the ViewableGroups property.

SYNTAX:

int getEffectiveGroupOffset();

INPUT:

None

RETURN:

int; effective group offset

EXAMPLE:

setDepthRadius (0);
setViewableGroups (3);
setScrollOffsetGroup (2);
setDataTextDisplay (true);
setDataValue (getSeriesGroup (0, 2), getEffectiveGroupOffset()));
setDataValue (getSeriesGroup (1, 2), getScrollOffsetGroup()));

ALSO SEE:

getEffectiveSeriesOffset(), ViewableGroups, ScrollOffsetGroup

getEffectiveSeriesOffset()

This method can be used to determine whether or not all series in the data set are being imaged in the chart. It returns the effective series offset (i.e., the total number of series in the data set minus the number of viewable series). The number of viewable series is set by the ViewableSeries property.

SYNTAX:

int getEffectiveSeriesOffset();

INPUT:

None

RETURN:

int: effective series offset.

EXAMPLE:

setDepthRadius (0);
setDataScrollerPresenceGroups (0);
setDataScrollerPresenceSeries (0);
setViewableSeries (3);
setScrollOffsetSeries (3);
setDataValue (getSeriesGroup (2, 0), getEffectiveSeriesOffset()));
setDataTextDisplay (true);

ALSO SEE:

getEffectiveGroupOffset(), ViewableSeries, ScrollOffsetSeries

getEffectiveViewableGroups()

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

SYNTAX:

int getEffectiveViewableGroups();

INPUT:

None

RETURN:

int; The number of viewable groups in the chart

EXAMPLE:

setDepthRadius (0);
setViewableGroups (3);
setScrollOffsetGroup (2);
setDataTextDisplay (true);
setDataValue (getSeriesGroup (0, 2), getEffectiveViewableGroups()));

ALSO SEE:

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

getEffectiveViewableSeries()

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

SYNTAX:

int getEffectiveViewableSeries();

INPUT:

None

RETURN:

int; The number of viewable series in the chart

EXAMPLE:

setDepthRadius (0);
setDataScrollerPresenceGroups (0);
setDataScrollerPresenceSeries (0);
setViewableSeries (3);
setScrollOffsetSeries (3);
setDataValue (getSeriesGroup (2, 0), getEffectiveViewableSeries()));
setDataTextDisplay (true);

ALSO SEE:

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

getHasGraphics2D()

This method returns true/false indicating whether or not the chart contains 2D graphics.

SYNTAX:

boolean getHasGraphics2D()

INPUT:

None

RETURN:

boolean; true = Chart has 2D graphics, false = Chart has no 2D graphics

getLegendMinWidth()

This method returns the smallest width (in virtual coordinates) such that none of the legend labels will wrap or truncate. Since it specifically calculates a WIDTH, it is applicable to Vertical legends only! If you try to call this method on a horizontal legend or before the legend has been created, this method returns zero.

SYNTAX:

int getLegendMinWidth();

INPUT:

None

RETURN:

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

hasBarOrMarkerSeries()

This function determines if any series in a chart is displayed as a Bar or a Line with markers.

SYNTAX:

boolean hasBarOrMarkerSeries()

INPUT:

None

RETURN:

boolean: true = One or more series are drawn as bar risers or markers, false = There are no series in the chart drawn as bars or markers

isChart3DType()

This method can be used to determine if the GraphType property is set to one of the 3D graphs.

SYNTAX:

boolean isChart3DType()

INPUT:

None

RETURN:

boolean; true = GraphType is set to one of the 3D charts, false = GraphType is not a 3D chart.

ALSO SEE:

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

isChartBipolar()

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

SYNTAX:

boolean isChartBipolar()

INPUT:

None

RETURN:

boolean; true = GraphType property is set to one of the bi-polar charts, false = GraphType is not a bi-polar chart.

ALSO SEE:

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

isChartBLAType()

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

SYNTAX:

boolean isChartBLAType();

INPUT:

None

RETURN:

boolean; true = GraphType is set to a bar, line, or area chart, false = GraphType is not a bar, line, or area chart.

ALSO SEE:

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

isChartDualY()

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

SYNTAX:

boolean isChartDualY();

INPUT:

None

RETURN:

boolean; true = GraphType property is set to one of the dual-axes charts, false = GraphType is not a dual-axes chart

ALSO SEE:

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

isChartOrientHorz()

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

SYNTAX:

boolean isChartOrientHorz();

INPUT:

None

RETURN:

boolean; true = GraphType property is set to one of the horizontal charts, false = GraphType selects a vertical chart

ALSO SEE:

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

isChartPieType()

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

SYNTAX:

boolean isChartPieType();

INPUT:

None

RETURN:

boolean; true = GraphType property is set to one of the pie charts, false = GraphType is not a pie chart

ALSO SEE:

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

isChartScatter()

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

SYNTAX:

boolean isChartScatter();

INPUT:

None

RETURN:

boolean; true = GraphType property is set to one of the scatter charts, false = GraphType is not a scatter chart

ALSO SEE:

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

isChartStockType()

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

SYNTAX:

boolean isChartStockType();

INPUT:

None

RETURN:

boolean; true = GraphType property is set to one of the stock charts, false = GraphType is not a stock chart

ALSO SEE:

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

isColorByGroup()

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

SYNTAX:

boolean isColorByGroup();

INPUT:

None

RETURN:

boolean; true = Color mode is set to color-by-group, false = Color-by-group is not selected

ALSO SEE:

ColorMode

isColorByHeight()

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

SYNTAX:

boolean isColorByHeight();

INPUT:

None

RETURN:

boolean: true = ColorByHeight object is used, false = ColorByHeight object is not used

ALSO SEE:

getColorByHeight(), ExactColorByHeight

isExceptionalAllowed()

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

SYNTAX:

boolean isExceptionalAllowed();

INPUT:

None

RETURN:

boolean: true = Exceptional risers are allowed, false = Exceptional risers are not allowed

Note:

This method is defined in the ObjClassID class.

ALSO SEE:

get/setExceptionalRiser(), getExceptionalRisers(), setNoExceptionalRiser()

isGroupScrollerPresent()

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

SYNTAX:

boolean isGroupScrollerPresent();

INPUT:

None

RETURN:

boolean: true = group scroller bar is present, false = group scroller bar is not present

NOTES:

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

ALSO SEE:

ScrollOffsetGroup, ViewableGroups, DataScrollerPresenceGroups

isO1AxisPresent()

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

SYNTAX:

boolean isO1AxisPresent();

INPUT:

None

RETURN:

boolean; true = O1 Axis is present, false = O1 Axis is not present

ALSO SEE:

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

isO2AxisPresent()

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

SYNTAX:

boolean isO2AxisPresent();

INPUT:

None

RETURN:

boolean; true = O2 Axis is present, false = O2 Axis is not present

ALSO SEE:

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

isSeriesScrollerPresent()

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

SYNTAX:

boolean isSeriesScrollerPresent();

INPUT:

None

RETURN:

boolean: true = series scroller bar is present, false = series scroller bar is not present

NOTES:

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

ALSO SEE:

ScrollOffsetSeries, ViewableSeries, DataScrollerPresenceSeries

isX1AxisPresent()

This method can be used to determine if the X-axis is present in a chart.

SYNTAX:

boolean isX1AxisPresent();

INPUT:

None

RETURN:

boolean; true = X-Axis is present, false = X-Axis is not present

ALSO SEE:

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

isY1AxisPresent()

This method can be used to determine if the primary numeric (Y1) axis is present in a chart.

SYNTAX:

boolean isY1AxisPresent();

INPUT:

None

RETURN:

boolean; true = Y1 Axis is present, false = Y1 Axis is not present

ALSO SEE:

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

isY2AxisPresent()

This method can be used to determine if the secondary numeric (Y2) axis is present in a chart. The Y2-axis is only present in dual axis charts.

SYNTAX:

boolean isY2AxisPresent();

INPUT:

None

RETURN:

boolean; true = Y2 Axis is present, false = Y2 Axis is not present

ALSO SEE:

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

isZ1AxisPresent()

This method can be used to determine if the Z-axis is present in a chart.

SYNTAX:

boolean isZ1AxisPresent();

INPUT:

None

RETURN:

boolean; true = Z1 Axis is present, false = Z1 Axis is not present

ALSO SEE:

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