Navigation:  Programmer's Reference > Sending data to DPlot from another application >

ContourLegend macro command

Print this Topic Previous pageReturn to chapter overviewNext page

Macro commands may be used either in macros or by sending the commands to DPlot via dynamic data exchange (DDE). Some commands are valid only in macros (noted by Macros Only). Commands sent to DPlot via DDE must be enclosed by square brackets [     ]. Macro commands should not include the brackets.

Command parameters shown in the descriptions below are placeholders for the actual values. Command parameters are either numeric values, equations that evaluate to numbers, or character strings. Character string parameters are always bound by double quotation marks. Equations must be preceded by an equals sign (=).

The pipe symbol (|) in the command syntax indicates that a parameter is optional, and should not be included in your macro unless otherwise noted.

All indices into arrays are 1-based, e.g. Curve1=1 refers to the first curve in a plot.

A 0x prefix for numbers in the descriptions below indicates hexadecimal notation; e.g. 0x0010 = 16.

JR/Viewer indicates that the command is supported by DPlot Jr or DPlot Viewer.
JR/Viewer indicates that the command is NOT supported by DPlot Jr or DPlot Viewer.



JR   Viewer

For non-zero state, draws a color-coded legend with values and intervals either automatically selected by DPlot or specified via the ContourLevels command. Equivalent to checking (state != 0) or unchecking (state=0) the Legend checkbox in the Draw box on the Contour Options dialog box.

The optional side parameter dictates which side of the plot the legend will be drawn on.
0 = left
1 = right
2 = top
3 = bottom

The default value is side=1 (right side), unless a settings file has been saved that includes the side setting.

The optional greatersymbol parameter determines whether DPlot will add > and/or < prefixes to the high and/or low contour legend entries. If non-zero and the extents of the amplitudes are more than one contour interval greater than the high contour value (or less than one contour interval less than the low contour value) then the corresponding prefix will be added to the legend. If set to 0, those prefixes will not be added. This setting has no effect on contour lines, only shaded bands and scatter plots.


See also

Contour Options menu command



Page url: