DADiSP Worksheet Functions > Function Categories > Query Functions > GETSYMBOLINTERVAL

 

GETSYMBOLINTERVAL

Purpose:

Returns the symbol interval of a series.

Syntax:

GETSYMBOLINTERVAL(series, item)

series

-

Optional. A series, defaults to the current Window.

item

-

Optional. An integer, the series number. The series number if the target is a Window with more than one series. Defaults to 1.

Returns:

An integer, the symbol interval.

Example:

W1: 1..20;setsym(14);setsymbolinterval(5);setsymboloffset(3)

 

symintv = getsymbolinterval(w1);

 

W1 contains a 20 point series where a circle is used as a symbol plotted every 5 points starting a the 3rd point.

 

symintv == 5

Remarks:

The symbol offset  only takes effect if SYMBOLINTERVAL > 1.

See Also:

GETSYMBOL

GETSYMBOLOFFSET

GETSYMBOLSIZE

SETPLOTSTYLE

SETSYMBOL

SETSYMBOLINTERVAL