DADiSP Online Help

Click here to see this page in full context

DADiSP Worksheet Functions > Function Categories > Display and Manipulation > GETXLABEL, GETYLABEL, GETZLABEL

GETXLABEL, GETYLABEL, GETZLABEL

Purpose:

Returns the x-axis, y-axis or z-axis label.

Syntax:

GETXLABEL(win)

GETYLABEL(win)

GETZLABEL(win)

win

-

Optional. Window reference. Defaults to the current Window.

Returns:

A string.

Example:

getxlabel(W3)

returns the x-axis label of Window 3.

Remarks:

If no label has been set, GETXLABEL returns the horizontal (x-axis) units, GETYLABEL returns the vertical (y-axis) units and GETZLABEL returns the height (z-axis) units. This is especially useful in custom menu and report panels. In both interactive and printed output, an axis label, if set, will cover whichever units label has been defined for the axis. If the user has set an axis label, then units will not appear.

See Also: