Toni: Toni moved page Programmer Guide/Macro Library/CGRAPHSETUP to Programmer Guide/Macro Library/Kernal/CGraphSetup without leaving a redirect

2018-03-07T09:43:46Z

Toni moved page Programmer Guide/Macro Library/CGRAPHSETUP to Programmer Guide/Macro Library/Kernal/CGraphSetup without leaving a redirect

← Older revision	Revision as of 11:43, 7 March 2018
(No difference)

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

2011-04-05T15:57:22Z

Text replace - "S_TOOLS-STx" to "{{STX}}"

← Older revision		Revision as of 17:57, 5 April 2011
Line 121:		Line 121:
	==IMPORT==		==IMPORT==

	Import a color scheme into the ~~S_TOOLS-STx~~ Workspace file.		Import a color scheme into the {{STX}} Workspace file.

	=====Usage:=====		=====Usage:=====
Line 140:		Line 140:
	==EXPORT==		==EXPORT==

	Export a color scheme into the ~~S_TOOLS-STx~~ Workspace file.		Export a color scheme into the {{STX}} Workspace file.

	=====Usage:=====		=====Usage:=====
Line 159:		Line 159:
	==GETPROFILELIST==		==GETPROFILELIST==

	Retrieve a list of color profiles defined in the ~~S_TOOLS-STx~~ INI file.		Retrieve a list of color profiles defined in the {{STX}} INI file.

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

Admin: 1 revision: Initial import

2010-11-18T16:31:27Z

1 revision: Initial import

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

Unknown user: initial import

1970-01-01T00:00:00Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}

==CGRAPHSETUP==

This macro (or the static functions of the class <code>CGraphSetup</code>) implements functions to start the graphics setup dialog and to load global graphics settings.

==DIALOG==

Starts the graphics setup dialog with the specified profile.

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

<code>CGRAPHSETUP DIALOG [ <var>profile</var> ]</code>

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

;<var>profile</var>

:The name of graphics profile (color scheme). If not specified, then the color scheme 'DEFAULT' is used.

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

The name of profile selected in the dialog.

==GETSETTINGS==

Loads the graphics profile and initializes the shell graphics settings variables with the specified color scheme data.

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

<code>CGRAPHSETUP GETSETTINGS [ <var>profile</var> ]</code>

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

;<var>profile</var>

:The name of graphics profile (if not specified DEFAULT is used).

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

None.

=====Notes:=====

Graphics settings variables. These shell variables are set by the function.

{|
|-
|variable name
|description
|-
|DCSET
|The name of the screen color table.
|-
|PCSET
|The name of the printer color table.
|-
|DCPAL
|The name of the screen palette table.
|-
|PCPAL
|The name of the printer palette table.
|-
|GGFONTTITLE
|The graph title font definition.
|-
|GGFONTAXIS
|The axis title font definition.
|-
|GGFONTLABELS
|The labels font definition.
|-
|GGFONTMARKER
|The segment marker font definition.
|-
|GGMINORXTICKS
|The number of minor ticks on the x scale.
|-
|GGMINORYTICKS
|The number of minor ticks on the y scale.
|-
|GGMAJORSIZE
|The size of the major ticks in pixels.
|-
|GGMINORSIZE
|The size of the minor ticks in pixels.
|-
|GGLINESTYLES
|The line styles (style1 width1 ... style5 width5).
|}

The palette tables are extended tables with the three fields R, G and B. Each entry defines one palette color.

The color tables are simple tables with four entries containing the following color definitions:

{|
|-
|<code>$#colortable[0]</code>
|<code>textbackgroundcolor plotbackgroundcolor</code>
|-
|<code>$#colortable[1]</code>
|<code>scalecolor labelscolor titlecolor gridcolor markerscolor</code>
|-
|<code>$#colortable[2]</code>
|<code>linecolor1 ... linecolor5</code>
|-
|<code>$#colortable[3]</code>
|<code>activecursorcolor inactivecursorcolor</code>
|}

==IMPORT==

Import a color scheme into the S_TOOLS-STx Workspace file.

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

<code>CGRAPHSETUP IMPORT [ <var>profile</var> ] [ ; <var>file</var> ]</code>

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

;<var>profile</var>

:The name of graphics profile (color scheme). If not specified, then the color scheme 'DEFAULT' is used.

;<var>file</var>

:The path to the file to import. If no file is supplied, the user is prompted to select a file from disk.

==EXPORT==

Export a color scheme into the S_TOOLS-STx Workspace file.

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

<code>CGRAPHSETUP EXPORT [ <var>profile</var> ] [ ; <var>file</var> ]</code>

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

;<var>profile</var>

:The name of graphics profile (color scheme). If not specified, then the color scheme 'DEFAULT' is used.

;<var>file</var>

:The path to the file to export to. If no file is supplied, the user is prompted to select a location to export to on disk.

==GETPROFILELIST==

Retrieve a list of color profiles defined in the S_TOOLS-STx INI file.

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

<code>CGRAPHSETUP GETPROFILELIST</code>

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

A simple table with one entry per profile containing the profile name.

==GRAPHLEGEND==

The <code>CGRAPHSETUP</code> command <code>GRAPHLEGEND</code> displays an amplitude legend in a spectrogram plot.

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

<code>CGRAPHSETUP GRAPHLEGEND <var>cmd</var> ; <var>graphItem</var> [ ; <var>xmin xmax ymin ymax</var> ]</code>

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

;<var>cmd</var>

:One of the keywords <code>ADD</code> or <code>REMOVE</code>.

;<var>graphItem</var>

:The id of a graph item containing a spectrogram plot

;<var>xmin, xmax, ymin, ymax</var>

:The position at which to display the legend. This is optional. If it is not specified, the legend is displayed at the right hand side of the graph.

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

None.

==GETCOLORPALETTE==

Retrieve a profile's color palette as an extended table.

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

<code>CGRAPHSETUP GETCOLORPALETTE <var>profile</var> [ <var>type</var> ]</code>

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

;<var>profile</var>

:The name of graphics profile (color scheme). If the profile does not exist, an empty table is returned.

;<var>type</var>

:One of the following values:

:<code>screen</code> - the screen palette is returned (default).

:<code>print</code> - the print palette is returned.

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

An extended table with three fields (R, G, and B) containing the color palette.

Array

Programmer Guide/Macro Library/Kernal/CGraphSetup - Revision history

Toni: Toni moved page Programmer Guide/Macro Library/CGRAPHSETUP to Programmer Guide/Macro Library/Kernal/CGraphSetup without leaving a redirect

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

Admin: 1 revision: Initial import

Unknown user: initial import