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

InsertImage 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

This command allows you to specify an image (BMP, EMF, GIF, JPG, PNG, or TIF) that will be drawn on the plot. Enhanced metafiles must have an extension of ".emf" to work properly with this command. Each plot may have up to 4 embedded images.

If the "filename" argument does not include a path, DPlot will look for it in My Documents\DPlot\Images. If the image does not reside in that folder then "filename" should include the full path to the file. All other parameters are optional.

flags0x0001 = X,Y in data space. If not set, X and Y specify the offset from the top left corner of the plot to the image anchor point, in inches.
0x0002 = Horizontally centered on the anchor point
0x0004 = Right-aligned on the anchor point
0x0008 = Middle-aligned vertically on the anchor point
0x0010 = Bottom-aligned on the anchor point
0x0020 = Draw in background (before any other objects). If not set, the image is drawn after all other objects.

Combine flags options by adding them.

width, heightWidth and height of the image, in inches.
transparencyGlobal transparency value applied to entire image. Valid range is 0 (invisible) to 255 (opaque). Default value = 255 (opaque). The transparency setting is ignored for enhanced metafiles.

Images are only applicable to 2D views of your data.


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

Insert Image menu command

DeleteImage macro command


Page url: