ReplaceAxisItem
int ReplaceAxisItem (int panelHandle, int controlID, int axis, int itemIndex, char itemLabel[], double itemValue);
Purpose
Replaces the string/value pair at a specific index in the list of label strings for a graph or strip chart axis. These strings appear in place of the numerical labels. They appear at the location of their associated values on the graph or strip chart.
To see string labels on an x-axis, set the ATTR_XUSE_LABEL_STRINGS attribute to TRUE. To see string labels on a y-axis, set the ATTR_YUSE_LABEL_STRINGS attribute to TRUE.
You can create the original list of label strings in the User Interface Editor or by calling InsertAxisItem.
Supported Controls
You can use ReplaceAxisItem 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 of the item to replace. |
| itemLabel | char [] | String to replace the existing string in the string/value pair at the specified index. If you pass 0, the existing string is not replaced. 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 to replace the existing value in the string/value pair at the index you specify. The string appears as an axis label 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