Series/Group Methods

deleteGroup()

This method deletes a group label from a chart.

SYNTAX:

void deleteGroup (int group);

INPUT:

group: group number

RETURN:

void;

EXAMPLE:

setGraphType (41);
setDepthRadius (0);
deleteGroup (0);

setGraphType (41);
setDepthRadius (0);
deleteGroup (2);

ALSO SEE:

deleteSeries()

deleteSeries()

This method deletes a group label attribute number from the lookProp object.

SYNTAX:

void deleteSeries (int series);

INPUT:

series: series label attribute number

RETURN:

void;

EXAMPLE:

setGraphType (41);
setDepthRadius (0);
deleteSeries (0);

setGraphType (41);
setDepthRadius (0);
deleteSeries (3);

ALSO SEE:

deleteGroup()

get/setIgnoreSeries()

These methods get/set true/false indicating whether or not a particular series is to be ignored.

SYNTAX:

boolean getIgnoreSeries();
boolean getIgnoreSeries (IdentObj id);
boolean getIgnoreSeries (int seriesID);
void     setIgnoreSeries (boolean newValue);
void     setIgnoreSeries (IdentObj id, boolean newValue);
void     setIgnoreSeries (int seriesID, boolean newValue);

INPUT:

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

seriesID; a series number

newValue; true = ignore (do not draw) series, false = do not ignore (draw) series

RETURN:

boolean; true = Series is ignored, false = Series is not ignored

EXAMPLE:

setDepthRadius (0);
setIgnoreSeries (2, true);

setIgnoreSeries (2, false);

NOTES:

If a specific object is not identified with the input parameters id or seriesID, these methods get/set the associated value (if any) for the first item in the selection list.

getMinNumGroups()

This method returns the minimum number of groups in a specified chart type.

SYNTAX:

int getMinNumGroups (int nIntegerGraphType);
int getMinNumGroups();

INPUT:

nIntegerGraphType; graph type number (0...106)

RETURN:

int; minimum number of groups for the specified chart type

NOTES:

If a graph type is not specified with nIntegerGraphType, this method will return the minimum number of groups required for the current chart type.

ALSO SEE:

getMinNumSeries()

getMinNumSeries()

This method returns the minimum number of series in a specified chart type.

SYNTAX:

int getMinNumSeries();
int getMinNumSeries (int nIntegerGraphType);

INPUT:

nIntegerGraphType; graph type number (0...106)

RETURN:

int; The minimum number of series for the graph type

NOTES:

If a graph type is not specified with nIntegerGraphType, this method will return the minimum number of series required for the current chart type.

ALSO SEE:

getMinNumGroups()

getNumNonIgnoredSeries()

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

SYNTAX:

int getNumNonIgnoredSeries();

INPUT:

None

RETURN:

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

ALSO SEE:

setIgnoreSeries()

getNumColumnsInGroup()

This method returns the number of groups required per data column for a particular graph type.

SYNTAX:

int getNumColumnsInGroup (int nIntegerGraphType);
int getNumColumnsInGroup();

INPUT:

nIntegerGraphType; graph type number

RETURN:

int; The number of columns in the group

NOTES:

If a graph type is not specified with nIntegerGraphType, this method will return the number of groups required per data column for the current chart type.

ALSO SEE:

getMinNumGroups(), getMinNumSeries()

getNumGroups()

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

SYNTAX:

int getNumGroups();

INPUT:

None

RETURN:

int; number of groups in the chart

ALSO SEE:

getNumTotalGroups(), getNumSeries(), getNumTotalSeries()

getNumSeries()

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

SYNTAX:

int getNumSeries();

INPUT:

None

RETURN:

int; The number of viewable series in the chart

ALSO SEE:

getNumGroups(), getNumTotalGroups(), getNumTotalSeries()

getNumTotalGroups()

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

SYNTAX:

int getNumTotalGroups();

INPUT:

None

RETURN:

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

EXAMPLE:

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

ALSO SEE:

getNumGroups(), getNumSeries(), getNumTotalSeries()

getNumTotalSeries()

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

SYNTAX:

int getNumTotalSeries();

INPUT:

None

RETURN:

int; total number of series in the data set that defines the chart

ALSO SEE:

getNumSeries(), getNumGroups(), getNumTotalGroups()

get/setSeriesBorderColor()

These methods get/set the border color of a particular series in a chart.

SYNTAX:

Color getSeriesBorderColor (int s);
void setSeriesBorderColor (int s, Color newValue);

INPUT:

s; a series number

newValue; RGB Color Value

RETURN:

Color; border color of series

EXAMPLE:

setSeriesBorderColor (4, new Color (0, 0, 0));
setDepthRadius (0);
setSeriesFillColor (4, new Color (255, 255, 255));
setSeriesBorderColor (3, new Color (0, 0, 0));
setSeriesFillColor (3, new Color (255, 255, 255));
setSeriesBorderColor (2, new Color (0, 0, 0));
setSeriesFillColor (2, new Color (255, 255, 255));
setSeriesBorderColor (1, new Color (0, 0, 0));
setSeriesFillColor (1, new Color (255, 255, 255));
setSeriesBorderColor (0, new Color (0, 0, 0));
setSeriesFillColor (0, new Color (255, 255, 255));

ALSO SEE:

get/setSeriesFillColor()

get/setSeriesFillColor()

These methods get/set the fill color of a specified series in a chart.

SYNTAX:

Color getSeriesFillColor (int s);
void setSeriesFillColor (int s, Color newValue);

INPUT:

s; series number

newValue; RGB Color Value

RETURN:

Color; fill color value of the specified series

EXAMPLE:

setSeriesBorderColor (4, new Color (0, 0, 0));
setDepthRadius (0);
setSeriesFillColor (4, new Color (255, 255, 255));
setSeriesBorderColor (3, new Color (0, 0, 0));
setSeriesFillColor (3, new Color (255, 255, 255));
setSeriesBorderColor (2, new Color (0, 0, 0));
setSeriesFillColor (2, new Color (255, 255, 255));
setSeriesBorderColor (1, new Color (0, 0, 0));
setSeriesFillColor (1, new Color (255, 255, 255));
setSeriesBorderColor (0, new Color (0, 0, 0));
setSeriesFillColor (0, new Color (255, 255, 255));

ALSO SEE:

get/setSeriesBorderColor()

get/setSeriesType()

These methods get/set an integer value that identifies the series type for a specific object, a specific series, or the first item in the selection list.

SYNTAX:

int getSeriesType();
int getSeriesType (IdentObj id);
int getSeriesType (int seriesID);
void setSeriesType (int newValue);
void setSeriesType (IdentObj id, int newValue);
void setSeriesType (int seriesID, int newValue);

INPUT:

id; object ID returned by a getObject() method (e.g., getSeries())

seriesID; series number

newValue; series type (0...3), 0 = Riser unspecified, 1 = Riser bar, 2 = Riser Marker, 3 = Riser Area

RETURN:

int; The series type (0...3). 0 = Riser unspecified, 1 = Riser bar, 2 = Riser Marker, 3 = Riser Area

EXAMPLE:

setDataRange (0, 0, 2, 2);
setDepthRadius (0);
setSeriesType (0, 1);
setSeriesType (1, 2);
setSeriesType (2, 3);

NOTES:

If a specific object is not identified with the input parameters id or seriesID, these methods get/set the associated value (if any) for the first item in the selection list.

setSeriesAreRows()

This method can be used to store series values and rows or columns and to swap the order of series and group labels. In the normal default configuration (setSeriesAreRows (false, false)), each row/column value defines a series/group. When serSeriesAreRows (true, true|false) is used, each row/column value defines a group/series data point.

SYNTAX:

void setSeriesAreRows ( boolean newValue, boolean swapLabels);

INPUT:

newValue; true = Store series as rows (the default), false = Store series as columns (reverse order)

swapLabels: true/false (only applicable if newValue is false). true = Swap Series and Group Labels, false = Do not swap series and group labels

RETURN:

void

EXAMPLE:

setUseSampleData (false);
setDepthRadius (0);
setData (0, 0, .5); // Row 0/Column 0
setData (0, 1, 1); // Row 0/Column 1
setData (0, 2, 2); // Row 0/Column 2
setData (0, 3, 3); // Row 0/Column 3
setData (1, 0, 10); // Row 1/Column 0
setData (1, 1, 11); // Row 1/Column 1
setData (1, 2, 12); // Row 1/Column 2
setData (1, 3, 13); // Row 1/Column 3
setDataRangeToExtent();
setSeriesLabel (0, "Series 0");
setSeriesLabel (1, "Series 1");
setGroupLabel (0, "Group 0");
setGroupLabel (1, "Group 1");
setGroupLabel (2, "Group 2");
setGroupLabel (3, "Group 3");
setSeriesAreRows (true, true);