Programmer Guide/Shell Items/Graph/NEW GRAPH: Difference between revisions

From STX Wiki
Jump to navigationJump to search
(initial import)
 
mNo edit summary
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==NEW GRAPH==
{{Graph Item}}
NEW GRAPH <var>name</var> <var>inputs</var> <var>display</var> <var>row</var> [<var>col</var>] [ /S|A ] [ /G ] [ /C ] [ /O ] [ /Nocopyprint ]


See [[Programmer Guide/Macro Library/BEGIN|SET GRAPH]] for the SET commands and [[User Guide/Transcription/SPExL - Transcription Tool|GRAPH Item Attributes]] for a list of attributes.
Create a graph item. The graph is assigned to a row and column in an existing [[Programmer Guide/Shell Items/Display|display item.]]
 
<code>NEW GRAPH <var>name inputs display row</var> [<var>col</var>] [ /S|A ] [ /G ] [ /C ] [ /O ]</code>
 
Create a graph item. The graph is assigned to a row and column in an existing display item.


The graph receives its data via inputs. The number of Y data inputs is defined in the <code>NEW GRAPH</code> command. The function defining the data source and drawing format can then be called for each Y input (See inputs and plots).
The graph receives its data via inputs. The number of Y data inputs is defined in the <code>NEW GRAPH</code> command. The function defining the data source and drawing format can then be called for each Y input (See inputs and plots).


;<var>name</var>
{| class="keinrahmen"
 
|-
:The unique name identifying this graph. If an asterisk is supplied, a unique name is automatically generated.
| <var>name</var>
 
| The unique name identifying this graph. If an asterisk is supplied, a unique name is automatically generated.
;<var>inputs</var>
|-
 
| <var>inputs</var>
:The number of (Y-data) inputs of the graph. An X input is always added.
| The number of (Y-data) inputs of the graph. An X input is always added.
 
|-
;<var>display</var>
| <var>display</var>
 
| The display item name where the graph will be displayed.
:The display item name where the graph will be displayed.
|-
 
| <var>row</var>, <var>col</var>
;<var>row, col</var>
| The location of graph in display (zero based indexes, 0/0 = top/left).
 
|-
:The location of graph in display (zero based indexes, 0/0 = top/left).
| <code>/S</code> or <code>/A</code>
 
| Display multiple inputs synchronously (/S) or asynchronously (/A).
;<var>/S|A</var>
|-
 
| <code>/G</code>
:Display multiple inputs synchronously (/S) or asynchronously (/A).
| Garbage collection. If specified, the item is automatically deleted when exiting the macro in which it was created.
 
|-
;<var>/G</var>
| <code>/Cursorrange=on</code> or <code>/Cursorrange=off</code>
 
| The <code>/C</code> option can be used to turn one-click range selection functionality on or off. By default, one-click range selection is on.
:Garbage collection. If specified, the item is automatically deleted when exiting the macro in which it was created.
|-
 
| <code>/O</code>
;<var>/Cursorrange=on|off</var>
| If the <code>/O</code> option is specified, zoom functionality is turned off. This may speed up graphs which contain a lot of data.
 
|-
:The /C option can be used to turn one-click range selection functionality on or off. By default, one-click range selection is on.
| <code>/Nocopyprint</code>
 
| Normally, the context menu for the graph will contain an entry "Copy/print" for printing the graph and for copying to the clipboard. This holds true even if you do not code a context menu at all - in this case, a context menu will be generated automatically, containing only the "Copy/print" entry. The <code>/Nocopyprint</code> option will override this behaviour: If you supply <code>/Nocopyprint</code>, any context menu you programmatically generate will not contain such a "Copy/print" menu. Likewise, if you do not code a context menu for the graph, <code>/Nocopyprint</code> will prevent the "Copy/print" context menu from being generated.
;<var>/O</var>
|}
 
:If the /O option is specified, zoom functionality is turned off. This may speed up graphs which contain a lot of data.

Latest revision as of 08:38, 12 May 2015

Graph Item
INTRODUCTION NEW SET ATTRIBUTES MESSAGES EXAMPLES 
NEW GRAPH name inputs display row [col] [ /S|A ] [ /G ] [ /C ] [ /O ] [ /Nocopyprint ]

Create a graph item. The graph is assigned to a row and column in an existing display item.

The graph receives its data via inputs. The number of Y data inputs is defined in the NEW GRAPH command. The function defining the data source and drawing format can then be called for each Y input (See inputs and plots).

name The unique name identifying this graph. If an asterisk is supplied, a unique name is automatically generated.
inputs The number of (Y-data) inputs of the graph. An X input is always added.
display The display item name where the graph will be displayed.
row, col The location of graph in display (zero based indexes, 0/0 = top/left).
/S or /A Display multiple inputs synchronously (/S) or asynchronously (/A).
/G Garbage collection. If specified, the item is automatically deleted when exiting the macro in which it was created.
/Cursorrange=on or /Cursorrange=off The /C option can be used to turn one-click range selection functionality on or off. By default, one-click range selection is on.
/O If the /O option is specified, zoom functionality is turned off. This may speed up graphs which contain a lot of data.
/Nocopyprint Normally, the context menu for the graph will contain an entry "Copy/print" for printing the graph and for copying to the clipboard. This holds true even if you do not code a context menu at all - in this case, a context menu will be generated automatically, containing only the "Copy/print" entry. The /Nocopyprint option will override this behaviour: If you supply /Nocopyprint, any context menu you programmatically generate will not contain such a "Copy/print" menu. Likewise, if you do not code a context menu for the graph, /Nocopyprint will prevent the "Copy/print" context menu from being generated.
Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Shell_Items/Graph/NEW_GRAPH&oldid=7445"

Navigation menu

Personal tools