DADiSP Worksheet Functions > Function Categories > Query Functions > GETZUNITS

 

GETZUNITS

Purpose:

Returns the height (Z) units of a 3D array.

Syntax:

GETZUNITS(series)

series

-

Optional. A series. Defaults to the current Window.

Returns:

A string.

Example:

W1: plot3d(rand(10));setvunits("V");sethunits("s");setzunits("N")

message(sprintf("The units of Window %d are %s per %s per %s", getwnum, getzunits, getvunits, gethunits))

 

displays a message box with the text - The units of Window 1 are Newtons per Volts per Second.

Remarks:

Especially useful in custom menu and report panels.

 

When using GETZUNITS without the series argument, GETZUNITS returns the z units of the series in focus.

See Also:

FOCUS

GETHUNITS

GETVUNITS

SETHUNITS

SETVUNITS

SETZUNITS

UNITS