Toni: moved Programmer Guide/Class Library/XGraph : CObjEx to Programmer Guide/Macro Library/XGraph

2011-04-28T08:02:42Z

moved Programmer Guide/Class Library/XGraph : CObjEx to Programmer Guide/Macro Library/XGraph

← Older revision	Revision as of 10:02, 28 April 2011
(No difference)

Admin: 1 revision: Initial import

2010-11-18T16:31:32Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==XGraph : CObjEx==

A class used by <code>[[Programmer Guide/Class Library/XPlot : CObjEx|XPlot]]</code> to access graph items.

====XGraph Construction====

Initialize a new <code>XGraph</code> instance.

=====Usage:=====

<code>XGraph <var>xplot</var> <var>row</var> <var>col</var></code>

=====Parameters:=====

;<var>xplot</var>

:The <code>XPlot</code> instance id to attach this graph to.

;<var>row</var>

:The row to attach this graph to.

;<var>col</var>

:The column to attach this graph to.

=====Result:=====

A new <code>XGraph</code> object if successful or an empty string.

====XGraph Member Functions====

The <code>XGraph</code> class implements the following member functions. See CObjEx Member Functions for a list of functions implemented in the parent class.

===addmetasegment===

Adds a metasegment to an existing graph or redraws all metasegments.

=====Usage:=====

<code><var>inst</var> addmetasegment <var>type</var> [ ; <var>x</var> ; <var>y</var> ; <var>mssettings</var> ; <var>text</var> ; <var>textsettings</var> ]</code>

=====Parameters:=====

;<var>type</var>

:If set to 1, all the metasegments are redrawn, otherwise, no redraw takes place.

;<var>x</var>

:The left and right position of the metasegment in the following format:

:<code>xmin xmax</code>

;<var>y</var>

:The top and bottom position of the metasegment in the following format:

:<code>ymin ymax</code>

;<var>mssettings</var>

:The metasegment style settings in the following format:

:<code>mode style linewidthy linecolor fillmode fillcolor</code>

:See the graph item metasegment documentation for details.

;<var>text</var>

:The text to display in the metasegment.

;<var>textsettings</var>

:The text settings in the following format:

:<code>textcolor horizontalAlign verticalAlign</code>

:See the graph item metasegment documentation for details.

=====Result:=====

If successful, the metasegment id.

=====Examples:=====

Redraw all metasegments in the graph:

<pre>
<code>$#xgraph addmetasegment 1</code>
</pre>
;<var></var>

===addplot_parameter===

Add a parameter plot to the existing graph.

=====Usage:=====

<code><var>inst</var> addplot_parameter <var>y</var> ; ; ; ; ; ; ; ; <var>fstyle</var> ;</code>

=====Parameters:=====

;<var>y</var>

:Either a table or a value item containing a matrix of values.

;<var>fstyles</var>

:

===addplot_xyplot===

=====Usage:=====

<code><var>xgraph</var> ADDPLOT_XYPLOT y ; x ; ; ; ; ; ; ; ; <var>fstyles</var> ;</code>

=====Parameters:=====

;<var>y</var>

;<var></var>

;<var>fstyles</var>

;<var></var>

===applysettings===

Apply the current settings to the graph.

=====Usage:=====

<code><var>inst</var> applysettings <var>key</var></code>

=====Parameters:=====

;<var>key</var>

:One of the following keywords:

:<code>all</code>|<code>profile</code>|<code>flags</code>

===deletemetasegments===

Deletes all metasegments in the graph.

<code><var>inst</var> deletemetasegments</code>

===get===

Get a graph attribute.

=====Usage:=====

<code><var>inst</var> get <var>attr</var></code>

=====Parameters:=====

;<var>attr</var>

:The attribute to get. The following attributes are supported:

:<code>GRAPH TYPE RANGE CURSORMODE CURSORPOSITION XDATA YDATA XUNIT YUNIT XTEXT YTEXT TITLE XPLOT ROW COLUMN</code>

=====Result:=====

The attribute's value or an empty string.

===legend===

Displays a function legend for xyplot and parameter plots.

=====Usage:=====

<code><var>inst</var> legend <var>unit</var> ; <var>x</var> ; <var>y</var> ; <var>w</var> ; <var>h</var> ; <var>tcolor</var> ; <var>info</var> ; <var>args</var></code>

=====Parameters:=====

;<var>unit</var>

:One of the following values:

:<code>real</code>|<code>%</code>|<code>percent</code>

;<var>x</var>

:The x position specified as values of unit <var>unit</var>.

;<var>y</var>

:The y position specified as values of unit <var>unit</var>.

;<var>w</var>

:The width as specified as values of unit <var>unit</var>.

;<var>h</var>

:The height as specified as values of unit <var>unit</var>.

;<var>tcolor</var>

:The text color.

;<var>info</var>

:One of the following values:

:<code>color</code>|<code>all</code>

;<var>args</var>

:Either a table with one text line per entry, or a blank separated list of words.

===msdelete===

=====Delete metasegments from the graph.=====

=====Usage:=====

<code><var>inst</var> msdelete [ <var>cmd</var> ]</code>

=====Parameters:=====

;<var>cmd</var>

:One of the following keywords:

:<code>selected</code> - deletes selected metasegments.

:<code>all</code> - deletes all metasegments.

:By default, selected metasegments are deleted.

===msghandler===

Overrides <code>CObj</code> <code>msghandler</code>. Implements the message handler for this graph and it's cursors.

=====Usage:=====

<code><var>inst</var> msghandler <var>type</var> <var>name</var> <var>id</var> <var>par</var></code>

=====Parameters:=====

See <code>CObj::msghandler</code> for details.

=====Result:=====

Returns 1

===msinsert===

Insert a metasegment into the graph, prompting user for input via a dialog.

=====Usage:=====

<code><var>inst</var> msinsert</code>

===play===

Play

=====Usage:=====

<code><var>inst</var> play [ <var>mode</var> ]</code>

=====Parameters:=====

;<var>mode</var>

:If <code>1</code>, play the whole range of the graph. Otherwise play the range between the cursors.

===plot_parameter===

Plots a parameter plot.

=====Usage:=====

<code><var>inst</var> plot_parameter <var>y</var> ; <var>title</var> ; <var>xrange</var> ; <var>xunit</var> ; <var>xtext</var> ; <var>yrange</var> ; <var>yunit</var> ; <var>ytext</var> ; <var>fstyles</var> ; <var>xlabtab</var> ; <var>ylabtab</var></code>

=====Parameters:=====

See XPlot::plot for details.

;<var></var>

===plot_spectrogram===

Plots a spectrogram plot.

=====Usage:=====

<code><var>inst</var> plot_spectrogram <var>d</var> ; <var>y</var> ; <var>title</var> ; <var>xrange</var> ; <var>xunit</var> ; <var>xtext</var> ; <var>yrange</var> ; <var>yunit</var> ; <var>ytext</var> ; <var>zrange</var> ; <var>xlabtab</var> ; <var>ylabtab</var></code>

=====Parameters:=====

See XPlot::plot for details.

===plot_textbox===

Plots a box with text in it.

=====Usage:=====

<code><var>inst</var> plot_textbox <var>title</var> ; <var>color</var> ; <var>halign</var> ; <var>valign</var> ; <var>textargs</var></code>

=====Parameters:=====

See XPlot::Plot for details.

===plot_waterfall===

Plots a 3D waterfall plot.

=====Usage:=====

<code><var>inst</var> plot_waterfall <var>d</var> ; <var>x</var> ; <var>title</var> ; <var>xrange</var> ; <var>xunit</var> ; <var>xtext</var> ; <var>yrange</var> ; <var>yunit</var> ; <var>ytext</var> ; <var>zrange</var> ; <var>zunit</var> ; <var>ztext</var> ; <var>xk</var> ; <var>yk</var> ; <var>nl</var> ; <var>xlabtab</var> ; <var>ylabtab</var> ; <var>zlabtab</var></code>

=====Parameters:=====

See <code>XPlot::Plot</code> for details.

===plot_waveform===

Plots a waveform plot.

=====Usage:=====

<code><var>inst</var> plot_waveform <var>wave</var> ; <var>title</var> ; <var>xunit</var> ; <var>xtext</var> ; <var>full</var> ; <var>ymax</var> ; <var>ytext</var> ; <var>fill</var> ; <var>xlabtab</var> ; <var>ylabtab</var></code>

=====Parameters:=====

See <code>XPlot::Plot</code> for parameter details.

===plot_xyplot===

Plots an X/Y plot.

=====Usage:=====

<code><var>inst</var> plot_xyplot <var>y</var> ; <var>x</var> ; <var>title</var> ; <var>xrange</var> ; <var>xunit</var> ; <var>xtext</var> ; <var>yrange</var> ; <var>yunit</var> ; <var>ytext</var> ; <var>fstyles</var> ; <var>xlabtab</var> ; <var>ylabtab</var></code>

=====Parameters:=====

See <code>XPlot::Plot</code> for details.

===redraw===

Redraw the graph. This function does not support waveform plots.

=====Usage:=====

<code><var>inst</var> redraw</code>

===set===

Sets graph attributes.

=====Usage:=====

<code><var>inst</var> set <var>attr</var> <var>argv</var></code>

=====Parameters:=====

;<var>attr</var>

:Either one of the following keywords:

:<code>cursormode</code>, <code>cursorposition</code>, <code>yrange</code>, <code>xunit</code>, <code>yunit</code>, <code>xtext</code>, <code>ytext</code> or <code>title</code>

:Or an integer between <code>1</code> and <code>7</code>.

;<var>argv</var>

:If <var>attr</var> is one of <code>cursormode</code>, <code>cursorposition</code>, <code>yrange</code>, <code>xunit</code>, <code>yunit</code>, <code>xtext</code>, <code>ytext</code> or <code>title</code>, then <var>argv</var> should supply the following values:

:<code>mode type line bind func</code>

:Where they can have the following values:

:<code>mode</code> - <code>off</code>|<code>on</code>

:<code>type</code> - <code>cross</code>|<code>crosshair</code>|<code>vbarcross</code>|<code>harmonic</code>

:<code>line</code> - <code>off</code>|<code>on</code>

:<code>bind</code> - <code>off</code>|<code>on</code>

:<code>func</code> - a zero-based index to set the current function

:If <var>attr</var> is <code>1</code>, then the cursor position and selected state is set and <var>argv</var> should supply the following values:

:<code>index x y selected</code>

:If <var>attr</var> is <code>2</code>, then the y-scale of the graph can be set, and <var>argv</var> should supply the following values:

:<code>ymin ymax</code>

:If <var>attr</var> is greater than 2, then the unit, text or title can be set, and <var>argv</var> should supply the relevant text:

:<var>attr</var>=<code>3</code> - xunit

:<var>attr</var>=<code>4</code> - yunit

:<var>attr</var>=<code>5</code> - xtext

:<var>attr</var>=<code>6</code> - ytext

:<var>attr</var>=<code>7</code> - title

===setflag===

Toggles the associated flags.

=====Usage:=====

<code><var>inst</var> setflag <var>cmd</var></code>

=====Parameters:=====

;<var>cmd</var>

:One of the following commands:

:<code>CMODE</code> - turns the cursor on/off <code>
CSTYLE</code> - rotates through available cursor styles<code>
CBIND</code> - binds/unbinds the cursor to the function<code>
CBINDNEXT</code> - binds the cursor to the next available function<code>
CBINDPREV</code> - binds the cursor to the previous available function<code>
CLINE</code> - turns the cursor line on/off<code>
TITLE</code> - turns the title on/off<code>
XSCALE</code> - rotates through available x-scale positions<code>
YSCALE</code> - rotates through available y-scale positions<code>
ZSCALE</code> - rotates through available z-scale positions

===setupdialog===

Displays the graph's setup dialog.

=====Usage:=====

<code><var>inst</var> setupdialog</code>

===setwave===

Set the wave item for this graph.

=====Usage:=====

<code><var>inst</var> setwave [ <var>masterwaveitem</var> ]</code>

=====Parameters:=====

;<var>masterwaveitem</var>

:The wave item which this graph should address. If no <var>masterwaveitem</var> parameter is specified, the current wave item (if any) is deleted.

=====Result:=====

0 on success, non-zero on failure.

===stopplayback===

Stops playback.

=====Usage:=====

<code><var>inst</var> stopplayback</code>

===updateContextMenu===

Updates the context menu, reflecting any changes that have been made to the graph.

=====Usage:=====

<code><var>inst</var> updateContextMenu</code>

===zoom===

Zoom into or out of the graph.

=====Usage:=====

<code><var>inst</var> zoom xin|xout|yin|yout</code>

<code><var>inst</var> zoom zin|zout</code>

<code><var>inst</var> zoom x|y|xy</code>

<code><var>inst</var> zoom toggle</code>

<code><var>inst</var> zoom reset</code>

=====Parameters:=====

;<var><code>xin</code>|<code>xout</code>|<code>yin</code>|<code>yout</code></var>

:Zoom in or out around the active cursor.

;<var><code>zin</code>|<code>zout</code></var>

:Change the spectrogram floor.

;<var><code>x</code>|<code>y</code>|<code>xy</code></var>

:Zoom between the cursors.

;<var><code>toggle</code></var>

:Toggle between zoom 'overview' and 'view' mode.

;<var><code>reset</code></var>

:Reset the zoom (zoom out completely).

Programmer Guide/Macro Library/XGraph - Revision history

Toni: moved Programmer Guide/Class Library/XGraph : CObjEx to Programmer Guide/Macro Library/XGraph

Admin: 1 revision: Initial import

193.171.195.8: initial import