InsertAxisItem
int InsertAxisItem (int panelHandle, int controlID, int axis, int itemIndex, char itemLabel[], double itemValue);
Purpose
Inserts a string/value pair into the list of label strings associated with a graph or strip chart axis. These strings appear instead of the numerical labels. They appear at the location of their associated values on the graph or strip chart.
The indices of existing string/value pairs at and beyond the specified index increase by 1.
To see string labels on an x-axis, you must set the ATTR_XUSE_LABEL_STRINGS attribute to TRUE. To see string labels on a y-axis, you must set the ATTR_YUSE_LABEL_STRINGS attribute to TRUE.
Supported Controls
You can use InsertAxisItem 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 only) |
| itemIndex | int | Zero-based index into the list at which to store the item. Pass –1 to store the item at the end of the list. itemIndex does not determine the order in which the labels appear on the axis. The value represents the order in which LabWindows/CVI stores the string/value pairs. You can use the index as a handle for replacing or deleting label/value pairs. |
| itemLabel | char [] | Label string to insert. The label appears on the axis at the location of the value you specify. When you call the ANSI version of the function, only the first 31 bytes of the string are shown in the axis label. When you call the UTF-8 version of the function, the byte limit of the axis label is 255. |
| itemValue | double | Value with which to associate the label string. The label string appears on the axis at the location of the value. |
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
Example
Refer to userint\timeaxis.cws for an example of using the InsertAxisItem function.