Programmer Guide/Shell Items/Graph/GRAPH Item Attributes

GRAPH Item Attributes

The graph shell item has the following attributes.

!CURSORLIMIT

The !CURSORLIMIT attribute returns either 'view' if the cursors are limited to the view or 'range' if the cursors may exist outside the view. You can set the cursor limit value using the shell graph CURSORMODE command

!CURSORMODE

The !CURSORMODE attribute returns '0' if both cursors are off, '1' if cursor one is on, '2' if cursor 2 is on, and '3' if both cursor 1 and 2 are on. See the graph item command CURSORMODE for more details.

!DISPLAY

The !DISPLAY attribute returns the name of the display item the graph is contained in.

!FUNCTIONS

The !FUNCTIONS attribute returns the number of functions displayed in the graph.

!INDEX

The !INDEX attribute returns the index of the graph item in the containing display item

!INPUTS

The !INPUTS attribute returns the number of Y data inputs attached to the graph.

If the !INPUTS attribute is called with an index as it's parameter like this:

$#graph[!inputs,$#i]

then the type of function used for the input is returned (e.g. spectrogram).

!MODE

The !MODE attribute returns the current mode the graph is in. This is one of the following:

overview - the graph is displaying the view as a metasegment within the whole range view - the graph is currently displaying part of the complete range range - the graph is displaying the complete range

!ORIENTATION

Get !ORIENTATION attribute gets the current orientation of the graph. See ORIENTATION for parameter details.

!RANGE

The !RANGE attribute returns the minimum and maximum values displayable on the axis in this graph. The returned string is a blank separated list of values. Note that the zmin and zmax values are only returned if the graph has a z-axis (i.e. a Waterfall graph):

xmin xmax ymin ymax [ zmin zmax ]

!SEGMENT

The !SEGMENT attribute gets information about metagsegments. There are three ways to use the !SEGMENT attribute.

1) Calling the !SEGMENT attribute without parameters like this:

$#graph[!SEGMENT]

returns the number of metasegments.

2) Calling the !SEGMENT attribute with an index as it's parameter like this:

$#graph[!SEGMENT,$#index]

will retrieve the following information:

idx id sel resmov xmin xmax ymin ymax

where

idx - the temporary index id - the permanent id sel - 0 if the metasegment is not selected, and one otherwise resmov - 1 if the metasegment has been moved since it was last set and 0 otherwise xmin, xmax - the position of the left and right of the metasegment in x range values ymin, ymax - the position of the top and bottom of the metasegment in y range values

3) Calling the !SEGMENT attribute with an id as the parameter like this:

$#graph[!segment,SegID1]

will return a string in the following format:

idx id sel resmov xmin xmax ymin ymax

See 2) for details.

Note that is should not be numbers, because numbers are used by the index query function.

!VIEW

The !VIEW attribute returns the area of the full range which is currently being displayed. The returned string as the following format:

xmin xmax ymin ymax [ zmin zmax ]

If the graph has not been zoomed, the !VIEW and !RANGE values are identical.