Axis & Scale Methods

get/setAxisAssignment(); Get/Set Axis Assignment
get/setAxisDescending(); Get/Set Axis Descending
get/setAxisOffset(); Get/Set Axis Offset
get/setAxisSide(); Get/Set Axis Side
get/setAxisSize(); Get/Set Axis Size
get/setDisplayOffScale(); Get/Set Display Offscale
get/setLogScale(); Get/Set Log Scale
get/setLogScaleBase(); Get/Set Log Scale Base
get/setNonZeroBaseline(); Get/Set Non-Zero Base Line
getNonZeroBaselineValue(); Get Non-Zero Base Line Value
get/setScaleMax(); Get/Set Scale Max
get/setScaleMaxAuto(); Get/Set Scale Max Auto
get/setScaleMin(); Get/Set Scale Min
get/setScaleMinAuto(); Get/Set Scale Min Auto
get/setScaleMustIncludeZero(); Get/Set Scale Must Include Zero
getX1ScaleMaxAutoValue(); Get X1 Scale Max Auto Value
getX1ScaleMinAutoValue(); Get X1 Scale Min Auto Value
getY1ScaleMaxAutoValue(); Get Y1 Scale Max Auto Value
getY1ScaleMinAutoValue(); Get Y1 Scale Min Auto Value
getY2ScaleMaxAutoValue(); Get Y2 Scale Max Auto Value
getY2ScaleMinAutoValue(); Get Y2 Scale Min Auto Value

get/setAxisAssignment()

In multi-Y axis charts, these methods get/set the axis assignment (Y1, Y2, Y3, Y4, or Y5) for a series, an object, or the first item in the selection list.

SYNTAX:

int getAxisAssignment();
int getAxisAssignment (IdentObj id);
int getAxisAssignment (int SeriesID);
void setAxisAssignment int newValue);
void setAxisAssignment (IdentObj id, int newValue);
void setAxisAssignment (int seriesID, int newValue);

INPUT:

id; Object ID of a Y-axis returned by getY1Axis(), getY2Axis(), getY3Axis(), getY4Axis(), or getY5Axis()

seriesID; series number

newValue; 0...4: 0 = Y1 Axis, 1 = Y2 Axis, 2 = Y3 Axis, 3 = Y4 Axis, 4 = Y5 Axis

RETURN:

int; 0...4: 0 = Y1 Axis, 1 = Y2 Axis, 2 = Y3 Axis, 3 = Y4 Axis, 4 = Y5 Axis

EXAMPLE:

setGraphType (21);
setAxisAssignment (getSeries (1), 0);
setAxisAssignment (getSeries (0), 1);

NOTES:

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

ALSO SEE:

get/setAxisAssignment(), get/setAxisSide(), Y1AxisSide, Y2AxisSide

get/setAxisDescending()

These methods get/set a boolean that identifies whether a numeric axis is drawn in ascending or descending order.

SYNTAX:

boolean getAxisDescending();
boolean getAxisDescending (IdentObj id);
void setAxisDescending (boolean newValue);
void setAxisDescending (IdentObj id, boolean newValue);

INPUT:

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

newValue; true/false; true = Descending, false = Ascending

RETURN:

boolean; true/false; true = Descending, false = Ascending

EXAMPLE:

setDepthRadius (0);
setViewableGroups (4);
setViewableSeries (4);
setDataScrollerPresenceGroups (0);
setAxisDescending (getY1Axis(), true);

NOTES:

If a specific object is not identified with the input parameter id, these methods get/set the associated value (if any) for the first item in the selection list.
You may also use one of the axis-specific properties (e.g., X1AxisDescending, Y1AxisDescending, etc.) to get/set the descending attribute of an axis.

ALSO SEE:

get/setAxisAssignment(), get/setAxisSide(), X1/Y1/Y2/Y3/Y4/Y5AxisDescending

get/setAxisOffset()

In Multi-Y charts (3 or more Y-axes), axes can overlap. The setAxisOffset() and setAxisSize() methods can be used to create a more desireable chart layout for Multi-Y axes charts. setAxisSize() sets the size of the frame, setAxisOffset() sets the axis offset from the base of the frame. The getAxisOffset() method returns the value set by setAxisOffset() for a specified Y-Axis.

SYNTAX:

int getAxisOffset();
int getAxisOffset (IdentObj id);
void setAxisOffset (int newValue);
void setAxisOffset (IdentObj id, int newValue);

INPUT:

id; Object ID of a Y-axis returned by getY1Axis(), getY2Axis(), getY3Axis(), getY4Axis(), or getY5Axis()

newValue; The axis offset 0...100. The default value is 0 (automatic).

RETURN:

int; The axis offset 0...100. The default value is 0 (automatic).

EXAMPLE:

setAxisAssignment (getSeries (0), 0);
setAxisAssignment (getSeries (1), 1);
setAxisAssignment (getSeries (2), 2);
setAxisAssignment (getSeries (3), 2);
setAxisOffset (getY1Axis(), 0);
setAxisOffset (getY2Axis(), 20);
setAxisOffset (getY3Axis(), 75);
setAxisSize (getY1Axis(), 20);
setAxisSize (getY2Axis(), 55);
setAxisSize (getY3Axis(), 25);
setGraphType (103);
setY1TitleString ("Y1 Axis");
setY2TitleString ("Y2 Axis");
setTextString (getY3Title(), "Y3 Axis");
setDepthRadius (0);

NOTES:

If a specific object is not identified with the input parameter id, these methods get/set the associated value (if any) for the first item in the selection list.
If the axis size is set to zero (automatic) by setAxisSize(), the axis offset will also be automatically calculated regardless of the value set by setAxisOffset().

ALSO SEE:

get/setAxisSize()

get/setAxisSide()

These methods get/set an integer value that identifies where an axis is imaged in the chart.

SYNTAX:

int getAxisSide();
int getAxisSide (IdentObj id);
void setAxisSide (int newValue);
void setAxisSide (IdentObj id, int newValue);

INPUT:

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

newValue; 0 = Left in vertical charts/Bottom in horizontal charts, 1 = Right in vertical charts/Top in horizontal charts, 2 = Both sides of chart

RETURN:

int; 0 = Left in vertical charts/Bottom in horizontal charts, 1 = Right in vertical charts/Top in horizontal charts, 2 = Both sides of chart

EXAMPLE:

setAxisSide (getY1Axis(), 1);

setAxisSide (getO1Axis(), 2);

NOTES:

If a specific object is not identified with the input parameter id, these methods get/set the associated value (if any) for the first item in the selection list.
You may also use one of the axis-specific properties (e.g., X1AxisSide, Y1AxisSide, etc.) to get/set where an axis is imaged.

ALSO SEE:

get/setAxisAssignment(), get/setAxisDescending(), O1AxisSide, X1/Y1/Y2AxisSide

get/setAxisSize()

In Multi-Y charts (3 or more Y-axes), axes can overlap. The setAxisOffset() and setAxisSize() methods can be used to create a more desireable chart layout for Multi-Y axes charts. setAxisSize() sets the size of the frame, setAxisOffset() sets the axis offset from the base of the frame.

SYNTAX:

int getAxisSize();
int getAxisSize (IdentObj id);
void setAxisSize (int newValue);
void setAxisSize (IdentObj id, int newValue);

INPUT:

id; Object ID of a Y-axis returned by getY1Axis(), getY2Axis(), getY3Axis(), getY4Axis(), or getY5Axis()

newValue; axis size 0...100 (0 = automatic). The default size is zero.

RETURN:

int; size of the specified axis (0...100). The default size is zero.

EXAMPLE:

setAxisAssignment (getSeries (0), 0);
setAxisAssignment (getSeries (1), 1);
setAxisAssignment (getSeries (2), 2);
setAxisAssignment (getSeries (3), 2); 
setAxisOffset (getY1Axis(), 0);
setAxisOffset (getY2Axis(), 20);
setAxisOffset (getY3Axis(), 75);
setAxisSize (getY1Axis(), 20);
setAxisSize (getY2Axis(), 55);
setAxisSize (getY3Axis(), 25);
setGraphType (103);
setDepthRadius (0);
setY1TitleString ("Y1 Axis");
setY2TitleString ("Y2 Axis");
setTextString (getY3Title(), "Y3 Axis");

NOTES:

If a specific object is not identified with the input parameter id, these methods get/set the associated value (if any) for the first item in the selection list.
If the axis size is set to zero (automatic), the axis offset will also be automatically calculated regardless of the value set by setAxisOffset().

get/setDisplayOffScale()

These methods get/set a boolean that identifies whether or not off-scale data points are imaged in a chart.

SYNTAX:

boolean getDisplayOffScale();
boolean getDisplayOffScale (IdentObj id);
void setDisplayOffscale (boolean newValue);
void setDisplayOffscale (IdentObj id, boolean newValue);

INPUT:

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

newValue; true/false; true = Draw offscale data points, false = Do not draw

RETURN:

boolean; true/false; true = Offscale values are imaged, false = Offscale values are not drawn

EXAMPLE:

setDepthRadius (0);
setDataValue (getSeriesGroup (0, 0), 100);
setDataRange (0, 0, 2, 2);
setDataTextDisplay (true);
setDisplayOffScale (getY1Axis(), true);

NOTES:

If a specific object is not identified with the input parameter id, these methods get/set the associated value (if any) for the first item in the selection list.
You may also use one of the object-specific properties to get/set the off-scale display attribute of a specific object (e.g., X1OffScaleDisplay, Y1OffScaleDisplay, etc.).

ALSO SEE:

X1/Y1/Y2OffScaleDisplay

get/setLogScale()

These method get/set logarithmic or linear scaling on an axis.

SYNTAX:

boolean getLogScale();
boolean getLogScale (IdentObj id);
void setLogScale (boolean newValue);
void setLogScale (IdentObj id, boolean newValue);

INPUT:

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

newValue; true = Logarithmic scale, false = Linear scale

RETURN:

boolean; Logarithmic or Linear scale set by setLogScale()

EXAMPLE:

setDepthRadius (0);
setY1MinorGridStep (0.5);
setY1MajorGridStep (1.0);
setY1MinorGridStepAuto (true);
setY1MajorGridStepAuto (true);
setLogScale (getY1Axis(), true);
setY1ScaleMaxAuto (true);
setY1ScaleMinAuto (true);
setY1MustIncludeZero (false);

NOTES:

If a specific object is not identified with the input parameter id, these method get/set the associated value (if any) for the first item in the selection list.
You may also use one of the axis-specific properties to determine whether logarithmic or linear scale is used on a particular axis (e.g., X1LogScale, Y1LogScale, Y2LogScale, etc.).

ALSO SEE:

get/setLogScaleBase(), X1/Y1/Y2/Y3/Y4/Y5LogScale

get/setLogScaleBase()

When logarithmic scaling is used on a numeric axis, these methods get/set the lowest/base value drawn on the axis.

SYNTAX:

double getLogScaleBase();
double getLogScaleBase (IdentObj id);
void setLogScaleBase (double newValue);
void setLogScaleBase (IdentObj id, double newValue);

INPUT:

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

newValue; Log scale base value

RETURN:

double; The base value used for logarithmic scaling

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setY1LogScale (true);
setLogScaleBase (getY1Axis(), 40);

NOTES:

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

ALSO SEE:

get/setLogScale()

get/setNonZeroBaseline()

These methods get/set use of non-zero baseline value on a numeric axis.

SYNTAX:

boolean getNonZeroBaseline();
boolean getNonZeroBaseline (IdentObj id);
void setNonZeroBaseline (boolean newValue);
void setNonZeroBaseline (IdentObj id, boolean newValue);

INPUT:

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

newValue; true = Non zero baseline, false = Zero baseline

RETURN:

boolean; true = Non zero baseline, false = Zero baseline

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setNonZeroBaseline (getY1Axis(), true);
setNonZeroBaselineValue (getY1Axis(), 10);

NOTES:

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

ALSO SEE:

get/setNonZeroBaselineValue()

get/setNonZeroBaselineValue()

When setNonZeroBaseline() enables a non-zero baseline, these methods get/set the location of the non-zero baseline. When a non-zero base line value is defined, risers with values greater than the baseline value draw up from the baseline; risers with values less than the baseline value draw down from the baseline.

SYNTAX:

double getNonZeroBaselineValue (IdentObj id);
void setNonZeroBaselineValue (IdentObj id, double fValue);

INPUT:

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

fValue; non-zero baseline value

RETURN:

double; the value set by setNonZeroBaselineValue()

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setNonZeroBaseline (getY1Axis(), true);
setNonZeroBaselineValue (getY1Axis(), 20);

NOTES:

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

ALSO SEE:

get/setNonZeroBaseline()

get/setScaleMax()

These methods get/set the maximum scale value assigned to a numeric axis.

SYNTAX:

double getScaleMax();
double getScaleMax (IdentObj id);
void setScaleMax (double newValue);
void setScaleMax (IdentObj id, double newValue);

INPUT:

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

newValue; a value identifying the maximum scale value on an axis

RETURN:

double; the maximum value that can be used on a numeric axis

EXAMPLE:

setDepthRadius (0);
setY1MajorGridStep (10.0);
setY1LogScale (false);
setScaleMax (getY1Axis(), 50.0);
setY1ScaleMaxAuto (false);
setY1ScaleMinAuto (true);
setY1MustIncludeZero (false);

NOTES:

If a specific object is not identified with the input parameter id, this method will return the associated value (if any) for the first item in the selection list.
You may also use one of the axis-specific properties to get the maximum scale on a particular axis (e.g., X1ScaleMax, Y1ScaleMax, Y2ScaleMax, etc.).
If setScaleMaxAuto() sets autoscaling to true, the value set by setScaleMax() will be ignored.

ALSO SEE:

get/setScaleMaxAuto(), get/setScaleMin(), get/setScaleMinAuto(), X1/Y2/Y2ScaleMax, X1/Y1/Y2ScaleMaxAuto

get/setScaleMaxAuto()

These methods get/set a boolean that indicates whether automatic or manual scaling is used for the maximum value on a numeric axis.

SYNTAX:

boolean getScaleMaxAuto();
boolean getScaleMaxAuto (IdentObj id);
void setScaleMaxAuto (boolean newValue);
void setScaleMaxAuto (IdentObj id, boolean newValue);

INPUT:

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

newValue; true = Maximum value is automatically calculated (automatic scaling), false = Maximum value is not automatically calculated (manual scaling)

RETURN:

boolean; true = Maximum value is automatically calculated (automatic scaling), false = Maximum value is not automatically calculated (manual scaling)

EXAMPLE:

setDepthRadius (0);
setY1MajorGridStep (10.0);
setY1LogScale (false);
setY1ScaleMax (50.0);
setScaleMaxAuto (getY1Axis(), false);
setY1ScaleMinAuto (true);
setY1MustIncludeZero (false);

NOTES:

If a specific object is not identified with the input parameter id, these methods get/set the associated value (if any) for the first item in the selection list.
You may also use one of the axis-specific properties to determine automatic/manual scaling on a particular axis (e.g., X1ScaleMaxAuto, Y1ScaleMaxAuto, etc.).
If this method sets a value of true, any value set by setScaleMax() is ignored.

ALSO SEE:

get/setScaleMax(), get/setScaleMin(), get/setScaleMinAuto(), X1/Y2/Y2ScaleMax, X1/Y1/Y2ScaleMaxAuto

get/setScaleMin()

These methods get/set the minimum scale value assigned to a numeric axis.

SYNTAX:

double getScaleMin();
double getScaleMin (IdentObj id);
void setScaleMin (double newValue);
void setScaleMin (IdentObj id, double newValue);

INPUT:

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

newValue; the minimum scaling value that can be used on an axis

RETURN:

double; the minimum scale value on the axis

EXAMPLE:

setDepthRadius (0);
setY1MajorGridStep (5.0);
setY1LogScale (false);
setY1ScaleMax (65.0);
setY1ScaleMaxAuto (true);
setScaleMin (getY1Axis(), 20.0);
setY1ScaleMinAuto (false);
setY1MustIncludeZero (false);

NOTES:

If a specific object is not identified with the input parameter id, these methods get/set the associated value (if any) for the first item in the selection list.
You may also use one of the axis-specific properties to get the minimum scale on a particular axis (e.g., X1ScaleMin(), Y1ScaleMin(), Y2ScaleMin(), etc.).
If setScaleMinAuto() sets autoscaling to true, the value set by setScaleMin() will be ignored.

ALSO SEE:

get/setScaleMax(), get/setScaleMaxAuto(), get/setScaleMinAuto()

get/setScaleMinAuto()

These methods get/set a boolean that identifies whether manual or automatic scaling is used for the minimum value on a numeric axis.

SYNTAX:

boolean getScaleMinAuto();
boolean getScaleMinAuto (IdentObj id);
void setScaleMinAuto (boolean newValue);
void setScaleMinAuto (IdentObj id, boolean newValue);

INPUT:

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

newValue; true = Minimum value is automatically calculated, false = Minimum value is not automatically calculated

RETURN:

boolean; true = Minimum value is automatically calculated, false = Minimum value is not automatically calculated

EXAMPLE:

setDepthRadius (0);
setY1MajorGridStep (5.0);
setY1LogScale (false);
setY1ScaleMax (65.0);
setY1ScaleMaxAuto (true);
setY1ScaleMin (20.0);
setScaleMinAuto (getY1Axis(), false);
setY1MustIncludeZero (false);

NOTES:

If a specific object is not identified with the input parameter id, these methods get/set the associated value (if any) for the first item in the selection list.
You may also use one of the axis-specific properties to determine automatic/manual scaling on a particular axis (e.g., X1ScaleMinAuto(), Y1ScaleMinAuto(), Y2ScaleMinAuto(), etc.).
If this method sets a value of true, any value set by setScaleMin() is ignored.

ALSO SEE:

get/setScaleMax(), get/setScaleMaxAuto(), get/setScaleMin()

get/setScaleMustIncludeZero()

These methods get/set a boolean that identifies whether or not a given axis must include zero.

SYNTAX:

boolean getScaleMustIncludeZero();
boolean getScaleMustIncludeZero (IdentObj id);
void setScaleMustIncludeZero (boolean newValue);
void setScaleMustIncludeZero (IdentObj id, boolean newValue);

INPUT:

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

newValue; true = Axis must include zero, false = Zero not required on this axis

RETURN:

boolean; true = Axis must include zero, false = Zero not required on this axis

EXAMPLE:

setGraphType (21); 
setDepthRadius (0);
setScaleMustIncludeZero (getY2Axis(), false);

setScaleMustIncludeZero (getY2Axis(), true);

NOTES:

If a specific object is not identified with the input parameter id, these methods get/set the associated value (if any) for the first item in the selection list.
You may also use one of the axis-specific properties to determine if a particular axis must include zero (e.g., X1MustIncludeZero, Y1MustIncludeZero, Y2MustIncludeZero, etc.).

ALSO SEE:

X1/Y1/Y2MustIncludeZero

getX1ScaleMaxAutoValue()

When the X1ScaleMaxAuto property is true (enabling automatic calculation of the maximum scaling value on the X1 axis), this method returns a double that identifies the maximum scale value that will be used on the X1 axis.

SYNTAX:

double getX1ScaleMaxAutoValue()

INPUT:

None

RETURN:

double; Minimum scale value on the X1 axis.

EXAMPLE:

setDepthRadius (0);
setGraphType (61);
setMarkerSizeDefault (100);
setDataValue (getSeriesGroup (0, 0), getX1ScaleMaxAutoValue());

ALSO SEE:

getX1ScaleMinAutoValue(), X1ScaleMaxAuto

getX1ScaleMinAutoValue()

When the X1ScaleMinAuto property is true (enabling automatic calculation of the minimum scaling value on the X1 axis), this method returns a double that identifies the minimum scale value that will be used on the X1 axis.

SYNTAX:

double getX1ScaleMinAutoValue()

INPUT:

None

RETURN:

double; Minimum scale value on the X1 axis.

EXAMPLE:

setDepthRadius (0);
setGraphType (61);
setMarkerSizeDefault (100);
setDataValue (getSeriesGroup (0, 0), getX1ScaleMinAutoValue());

ALSO SEE:

getX1ScaleMaxAutoValue(), X1ScaleMinAuto

getY1ScaleMaxAutoValue()

When the Y1ScaleMaxAuto property is true (enabling automatic calculation of the maximum scaling value on the Y1 axis), this method returns a double that identifies the maximum scale value that will be used on the Y1 axis.

SYNTAX:

double getY1ScaleMaxAutoValue()

INPUT:

None

RETURN:

double; Minimum scale value on the Y1 axis.

EXAMPLE:

setDepthRadius (0);
setViewableGroups (2);
setDataScrollerPresenceGroups (0);
setGraphType (21);
setDataValue (getSeriesGroup (1, 0), getY1ScaleMaxAutoValue());
setDataTextDisplay (true);

ALSO SEE:

getY1ScaleMinAutoValue(), Y1ScaleMaxAuto

getY1ScaleMinAutoValue()

When the Y1ScaleMinAuto property is true (enabling automatic calculation of the minimum scaling value on the Y1 axis), this method returns a double that identifies the minimum scale value that will be used on the Y1 axis.

SYNTAX:

double getY1ScaleMinAutoValue()

INPUT:

None

RETURN:

double; Minimum scale value on the Y1 axis.

EXAMPLE:

setDepthRadius (0);
setViewableGroups (2);
setDataScrollerPresenceGroups (0);
setGraphType (21);
setDataValue (getSeriesGroup (1, 0), getY1ScaleMinAutoValue());
setDataTextDisplay (true);
setNonZeroBaseline (getY2Axis(), true);
setNonZeroBaselineValue (getY2Axis(), 10);
setDataTextPosition (3);

ALSO SEE:

getY1ScaleMaxAutoValue(), Y1ScaleMinAuto

getY2ScaleMaxAutoValue()

When the Y2ScaleMaxAuto property is true (enabling automatic calculation of the maximum scaling value on the Y2 axis), this method returns a double that identifies the maximum scale value that will be used on the Y2 axis.

SYNTAX:

double getY2ScaleMaxAutoValue()

INPUT:

None

RETURN:

double; Minimum scale value on the Y2 axis.

EXAMPLE:

setDepthRadius (0);
setViewableGroups (2);
setDataScrollerPresenceGroups (0);
setGraphType (21);
setDataValue (getSeriesGroup (1, 0), getY2ScaleMaxAutoValue());
setDataTextDisplay (true);

ALSO SEE:

getY2ScaleMinAutoValue(), Y2ScaleMaxAuto

getY2ScaleMinAutoValue()

When the Y2ScaleMinAuto property is true (enabling automatic calculation of the minimum scaling value on the Y2 axis), this method returns a double that identifies the minimum scale value that will be used on the Y2 axis.

SYNTAX:

double getY2ScaleMinAutoValue()

INPUT:

None

RETURN:

double; Minimum scale value on the X1 axis.

ALSO SEE:

getY2ScaleMaxAutoValue(), Y2ScaleMinAuto