GETCOLORBARLABEL

Purpose:

Returns the label of a vertical color bar.

Syntax:

GETCOLORBARLABEL(win)

win

-

Optional. A Window, the target Window of the colormap. Defaults to the current Window.

Returns:

A string, the label of the colorbar. Returns an empty string if the window does not contain a colorbar.

Examples:

W1: spline2(randn(5), 10);setplottype(3);setzunits("V");colorbar;setcolorbarlabel(1)

 

clabel = getcolorbarlabel(w1)

 

W1 contains a 41x41 array. The array is displayed as an image and the Z units are set to "Volts". A colorbar is added and the label of the colorbar is set to the Z units. The variable clabel contains the string "Volts".

Remarks:

GETCOLORBARLABEL returns an empty (zero length) string if the target window does not contain a colorbar.

See Also:

COLORBAR

FOCUS

SETCOLORBARLABEL

YLABEL