GETVUNITS

Purpose:

Returns the vertical (Y) units of a series.

Syntax:

GETVUNITS(series, col)

series

-

Optional. A series. Defaults to the current Window.

col

-

Optional. An integer, the column number. Defaults to 1, the first column.

Returns:

A string.

Example:

W1: gnorm(1000, 1);setvunits("V");sethunits("s");

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

 

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

Example:

W1: randn(100, 3);setvunits("V", 1);setvunits("A", 2);setvunits("N", 3)

 

getvunits(w1, 1) == "Volts"

getvunits(w1, 2) == "Amps"

getvunits(w1, 3) == "Newtons"

 

W1 contains a 10x3 random array. The vertical (Y) units of each column are individually set and retrieved.

Remarks:

Especially useful in custom menu and report panels.

 

When using GETVUNITS without the series argument, GETVUNITS returns the vertical units of the series in focus.

See Also:

FOCUS

GETHUNITS

GETZUNITS

SETHUNITS

SETVUNITS

SETZUNITS

UNITS