GetAxisScalingMode

int GetAxisScalingMode (int panelHandle, int controlID, int axis, int *axisScaling, double *min, double *max);

Purpose

Obtains the scaling mode and the range of a graph axis or the range of the y-axis of a strip chart.

GetAxisScalingMode is not valid for the x-axis of a strip chart. To obtain the x-offset and x increment for a strip chart, use GetCtrlAttribute with the ATTR_XAXIS_OFFSET and ATTR_XAXIS_GAIN attributes.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by NewCtrl or DuplicateCtrl.
axis integer Specifies for which axis to obtain the mode and range. The following lists the valid values:

VAL_BOTTOM_XAXIS (graphs only)
VAL_TOP_XAXIS (graphs only)
VAL_LEFT_YAXIS (graphs and strip charts)
VAL_RIGHT_YAXIS (graphs only)
Output
Name Type Description
axisScaling integer The current scaling mode used for the graph axis.

The following table lists the values of axisScaling.

VAL_MANUAL Axis is manually scaled, and min and max define its range.
VAL_AUTOSCALE Axis is autoscaled. min and max are not used. VAL_AUTOSCALE is not valid for strip charts.
If you call SetAxisScalingMode with axisScaling set to VAL_AUTOSCALE, and you then call SetAxisScalingMode with axisScaling set to VAL_LOCK, GetAxisScalingMode returns axisScaling as VAL_MANUAL.

You can pass NULL for this parameter.
min double-precision Current minimum value on the axis.

You can pass NULL for this parameter.
max double-precision Current maximum value on the axis.

You can pass NULL for this parameter.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success