DADiSP Worksheet Functions > Function Categories > Query Functions > GETYL

 

GETYL

Purpose:

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

Syntax:

GETYL(win)

(yl, idx) = GETYL(win)

win

-

Optional. Window reference. Defaults to the current Window.

Returns:

A real or complex value, the leftmost Y value.

 

(yl, idx) = GETYL(win) returns the Y value and associated index.

Example:

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

 

yl = getyl(W1);

 

yl == 5.0

 

indicating the leftmost sample of the series displayed in W1 has a value of 5.0.

Example:

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

 

(yl, idx) = getyl(W1);

 

yl  == 5.0

idx == 41

 

indicating the leftmost sample of the series displayed in W1 has a value of 5.0 and occurs at index 41.

Remarks:

See GETYR to returns the rightmost Y value a displayed series.

See Also:

GETXL

GETXLIDX

GETXR

GETXRIDX

GETYB

GETYR

GETYT

XTOIDX