DADiSP Worksheet Functions > Function Categories > Query Functions > GETYR

 

GETYR

Purpose:

Returns the rightmost Y value of a series displayed in a Window.

Syntax:

GETYR(win)

(yr, idx) = GETYR(win)

win

-

Optional. Window reference. Defaults to the current Window.

Returns:

A real or complex value, the rightmost Y value.

 

(yr, idx) = GETYR(win) returns the Y value and associated index.

Example:

W1: 1..0.1..10;setx(5, 9);

 

yr = getyr(W1);

 

yr == 9.0

 

indicating the rightmost sample of the series displayed in W1 has a value of 9.0.

Example:

W1: 1..0.1..10;setx(5, 9);

 

(yr, idx) = getyr(W1);

 

yr  == 9.0

idx == 81

 

indicating the rightmost sample of the series displayed in W1 has a value of 9.0 and occurs at index 81.

Remarks:

See GETYL to returns the leftmost Y value of a displayed series.

See Also:

GETXL

GETXLIDX

GETXR

GETXRIDX

GETYB

GETYL

GETYT

XTOIDX