Programmer Guide/Shell Items/Graph/GRAPH Item Attributes

This chapter describes the attributes of STx graph shell items. Like with all types of STx shell items, the respective attributes may be retrieved like this:

#s := $#graphItem[!CURSORLIMIT]

!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 command SET graph CURSORMODE.

!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 SET graph CURSORMODE for 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 its argument then the type of function used for the input is returned (e.g. spectrogram):

#type := $#graph[!inputs,$#i]

!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 SET graph 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.

Without arguments

Without further arguments, the !SEGMENT attribute returns the number of metasegments:

#n := $#graph[!SEGMENT]

With a segment index or segment ID as its argument

#n := $#graph[!segment,segmentIndex]
#n := $#graph[!segment,segmentID]

When called with the index or the ID of a segment as its argument, the !SEGMENT attribute will return the following information for the segment whose respective numerical index is segmentIndex or whose name is (segmentID):

idx id sel resmov xmin xmax ymin ymax

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

#s := $#graph[!SEGMENT,$#index]
readvar #s #idx #id #sel #resmov #xmin #xmax #ymin #ymax

#s := $#graph[!SEGMENT,segmentSusan]
readvar #s #idx #id #sel #resmov #xmin #xmax #ymin #ymax

!VIEW

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

xmin xmax ymin ymax [ zmin zmax ]

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