AltFmtFrameSeparator

Alternate formatting objects and methods can be used to apply different colors to sections of an axis and axis labels. You may also define a text label to show with an alternate formatted section.

These methods get/set the location on an axis where alternate formatting is applied.

Syntax:

double getAltFmtFrameSeparator (IdentObj idObj);
void setAltFmtFrameSeparator(IdentObj idObj,double newValue);

where:

idObj

Is the object ID of an alternate formatting axis object (for example, getY1AltFmtFrame(), getO1AltFmtFrame(), and others).

newValue

For setAltFmtFrameSeparator(), the location on the axis where alternate formatting will be applied. For a numeric axis, specify a value that is within the range of values on the specified axis. For the ordinal (O1) axis, specify a group number that is within the range of groups on the ordinal axis.

Return:

double

For getAltFmtFrameSeparator(), the axis location where alternate formatting is applied.

The following objects support alternate formatting of an axis and axis labels.

Use setDisplay() and omit the nIndex parameter to enable alternate formatting of the axis and/or axis labels. Example:

When alternate formatting is enabled for an axis, use the alternate formatting methods to define how many sections/colors will be defined and the location on the axis to separate the sections.

See Alternate Formatting.


WebFOCUS