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.

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)
itemIndex integer Zero-based index of the first item to delete.
numberOfItems string Number of items to delete. To delete all items from itemIndex to the end, pass –1.

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