GetAxisScalingMode
int GetAxisScalingMode (int panelHandle, int controlID, int axis, int *scalingMode, double *min, double *max);
Purpose
Obtains the scaling mode and the range of a graph axis or the scaling mode and the range of a 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.
Supported Controls
You can use GetAxisScalingMode with the following controls:
Parameters
| Input | ||||||
| Name | Type | Description | ||||
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. | ||||
| controlID | int | 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 functions such as NewCtrl and DuplicateCtrl. | ||||
| axis | int | 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 and strip charts) |
||||
| Output | ||||||
| Name | Type | Description | ||||
| scalingMode | int | The current scaling mode used for the graph axis or strip chart y-axis. The following table lists the values of axisScaling.
You can pass NULL for this parameter. |
||||
| min | double | Current minimum value on the axis. You can pass NULL for this parameter. |
||||
| max | double | Current maximum value on the axis. You can pass NULL for this parameter. |
||||
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 4.0 and later
Examples
Refer to the following examples that use the GetAxisScalingMode function:
- userint\GraphAnnotations.cws
Open example - userint\GraphZooming.cws
Open example - userint\TimeDateUnits.cws
Open example