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

Refline 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

Creates a reference line with value = some constant X (XY plots only) or constant Y (XY or 1D plot) with line style style (0-7). Color is a single number equal to (red+green*256+blue*65536), with each component ranging from 0-255. Color may be expressed as a decimal number or as a hexadecimal value with a 0x prefix, which is often more convenient. For example orange (red=255, green=153, blue=0) can be specified with 0x0099FF. Line width is in 1000'ths of inches. The optional label will be added to the plot legend if used, or be drawn centered on the reference line if the 0x0004 bit of Options is set.. Options is a combination of:

0x0001Reference value is a constant Y, line will be horizontal. If not set, reference value is a constant X and the line will be vertical. For 1D plots this flag is implied. For polar plots if this flag is set, value specifies the radius of a circle. If not set, value is the angular value in degrees.
0x0002internal use only
0x0004Label (if included) will be drawn centered on the line rather than placed in the legend. This option is ignored for 3D data: the label will always be drawn centered on the line.
0x0008Reference value is associated with the secondary X axis.
0x0010Reference value is associated with the secondary Y axis.
0x0020A black frame will be drawn around the label. This setting is ignored if the 0x0004 bit is not set.
0x0040The label will be opaque. This setting is ignored if the 0x0004 bit is not set.
0x0080The reference line and any associated legend entries will be hidden (not drawn).

Combine options by adding them.


Please note:

Character string arguments require a bit of care, depending on your development environment. Character string arguments in all DPlot commands are always enclosed by double quotation marks. In some environments (Visual Basic and all flavors of C, for example), double quotation marks are also used to delineate all character strings (including the command itself). The following example will always cause a syntax error in Visual Basic:

ret = DPlot_Command(docnum,"[FileOpen("myfile.grf")]")

Instead, use:

ret = DPlot_Command(docnum,"[FileOpen(""myfile.grf"")]")

in C, C++, C# you'd accomplish the same thing with:

ret = DPlot_Command(docnum,"[FileOpen(\"myfile.grf\")]");

If a character string argument is a variable, as in (VB):

Dim arg as string
arg = "myfile.grf"

... then you can build the command in VB as:

ret = DPlot_Command(docnum,"[FileOpen(" & chr$(34) & arg & chr$(34) & ")]")

In all flavors of C, the same can be accomplished with

char arg[256];
char cmd[512];
ret = DPlot_Command(docnum,cmd);

This does not apply to the DPlot macro editor, in which each line is by definition a character string and does not require delineators, nor to FORTRAN and possibly other languages, in which the delineator for character strings is a single quote, e.g. '[FileOpen("...")]'

To embed a double quotation mark within a character string which is itself delineated by double quotation marks, use the Symbol font equivalent instead. For example, "Radius=6{\s²}" inches will be processed as





See also

Reference Lines menu command


Page url: