GETHUNITS

Purpose:

Returns the horizontal (X) units of a series.

Syntax:

GETHUNITS(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:

gethunits(W3)

 

returns the horizontal units of Window 3.

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);sethunits("Hz", 1);sethunits("m", 2);sethunits("N", 3)

 

gethunits(w1, 1) == "Hertz"

gethunits(w1, 2) == "Meters"

gethunits(w1, 3) == "Newtons"

 

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

Remarks:

Especially useful in custom menu and report panels.

 

When using GETHUNITS without the series argument, GETHUNITS returns the horizontal units of the series in focus.

See Also:

FOCUS

GETVUNITS

GETZUNITS

SETHUNITS

SETVUNITS

SETZUNITS

UNITS