DeleteAxisItem
int DeleteAxisItem (int panelHandle, int controlID, int axis, int itemIndex, int numberOfItems);
Purpose
Deletes one or more string/value pairs from 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, 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 DeleteAxisItem 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 first item to delete. |
| numberOfItems | int | Number of items to delete. To delete all items from itemIndex to the end, pass –1. |
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