Use this interface to obtain access to the DM2003 graphics engine. Methods and properties of IDMPlot2 allows you to manipulate axes, labels and series objects, as well as perform editing operations, control selection area and reaction on the mouse events.
Although IDMPlot2 looks like usual collection of series objects, accessible through Series() array, it has one specific feature, namely CurrentSerie. It was found to be very convenient to perform operations on a single serie object at a time. This is because plot serie itself is a complex object, in contradistinction from characters in the text editor or strings in regular collections.
|Return Serie object for current serie
|Return Axis object for X axis
|Return Axis object for Y axis
|Set plot selection
|Create new plot serie
|Return Serie object for selected serie
|Swap order of two plot series
|Delete plot serie
|Return Axis object for X axis 2
|Return Axis object for Y axis 2
|Change plot color
|True if undo zoom is possible
|Undoes last zoom operation
|Save plot page to disk file as metafile
|Print plot page
|Returns owner document object
|Return Series enumerator object
|Return Labels collection
|True if clipboard has serie or/and label objects
|Paste serie or/and label objects
|r/o property SerieCount: Long
Returns number of series in Series array.
|property SerieIndex: Long
Like one of document windows is active, one of plot series is current. Current serie displayed in serie toolbar and most of UI operations act on the current serie. This property allows you to change index of current serie programmatically (series are indexed from 0 to SerieCount-1).
|r/o property CurrentSerie: IDispatch
This property returns current serie object; it is equal to Series[SerieIndex]. Note that CurrentSerie may be nil if SerieIndex<0 or SerieCount=0.
|r/o property XAxis: IDispatch
For DMPlot, XAxis returns reference to the DMAxis object that represents bottom plot axis.
For DMSerie and DMLabel, XAxis property returns reference to the DMAxis object and allows you to change horizontal axis associated with given label or series (which is used to introduce coordinate system for rendering series points or label object).
dim Plt set Plt=Server.ActiveDocument.Plot Plt.CurrentSerie.XAxis=Plt.XAxis2 Plt.Labels(0).XAxis=Plt.XAxis2
|r/o property YAxis: IDispatch
For DMPlot, YAxis returns reference to the DMAxis object that represents left plot axis.
For DMSerie and DMLabel, YAxis property returns reference to the DMAxis object and allows you to change vertical axis associated with given label or series (which is used to introduce coordinate system for rendering series points or label object).
dim Plt set Plt=Server.ActiveDocument.Plot Plt.CurrentSerie.YAxis=Plt.YAxis2 Plt.Labels(0).YAxis=Plt.YAxis2
|property SelectionTop: Double
For DMPlot, this property is a double-precision coordinate of the top of the plot selection area.
For DMWorksheet, this property is an integer position of the top line in the selected block of cells, or the vertical position of the selected cell.
|property SelectionBottom: Double
For DMPlot, this property is a double-precision coordinate of the bottom of the plot selection area.
For DMWorksheet, this property is an integer position of the bottom line in the selected block of cells, or the vertical position of the selected cell.
|property SelectionLeft: Double
For DMPlot, this property is a double-precision coordinate of the left of the plot selection area.
For DMWorksheet, this property is an integer position of the left column in the selected block of cells, or the horizontal position of the selected cell. Note that columns are counted from 1!
|property SelectionRight: Double
For DMPlot, this property is a double-precision coordinate of the right of the plot selection area.
For DMWorksheet, this property is an integer position of the right column in the selected block of cells, or the horizontal position of the selected cell. Note that columns are counted from 1!
|function CopyToClipboard(Mode, UseTabs): VOID
For DMNotes, this method copies selected text on the clipboard as in any text editor.
For DMPlot, CopyToClipboard has a parameters. Mode parameter determine what data will be copied; possible values listed in the PlotCopyModes enumeration. UseTabs parameter defines what character will be used as separator between values: some programs can correctly paste values only if they are separated by tabstop character. Keep in mind that CopyToClipboard acts only on the data in the current plot serie, and only points whose coordinates are within the selection area are copied. If plot selection is not visible, all points or data elements are copied.
For both DMSerie and DMLabel, properties of the object are copied in the special binary format.
For DMWorksheet, it copies selected worksheet cells to the clipboard as a simple text block. UseTabs parameter also defines what character will be used as separator between values. It also puts selection data range as a serie object.
You can use system Clipboard Viewer utility to investigate what data formats are used at every case.
|function Delete: VOID
For DMRegistry and DMINIFile, Delete method deletes selected Value (or INI file section). Name parameter is either name or index in the Items collection. If object was opened in the Read-Only mode, Delete call will have no effect.
For DMNotes, DMPlot and DMWorksheet objects Delete method has no parameters and should be used to delete selected data range in the appropriate objects: selected text, worksheet cells or "selected" points (points whose coordinates belong to selected plot area) in the current plot serie. Note that for DMPlot, if selection is not visible, all points from the current plot serie will be deleted.
|function Select(X1, X2, Y1, Y2): VOID
For DMNotes object, this method should be used to select text in the editor. SelStart and SelEnd parameters are first and last character positions.
For DMPlot object, Select() changes numeric (double precision) coordinates of the plot selection area. This area may be visualized using SelectionVisible property and affects on some plot editing commands.
For DMWorksheet, this method defines integer coordinates of the worksheet selection. Left and Right ranges are (1..26), Top and Bottom are (0..Container.ItemCount-1).
For DMSerie, Select() has almost the same meaning as for DMWorksheet. Columns are ranged from 1 to 26, lines - from 0 to Container.ItemCount-1. However, XCol and YCol must represent valid data, that is, all items in the selected data range must have appropriate number of columns.
For DMLabel, this method allows you programmatically select label object. Notice that Select() has no effect until IDMPlot2.MouseMode<>pmmLabelEdit.
|function AddSerie: IDispatch
Adds a new DMSerie object to the end of Series() array and return reference to this object.
|r/o property Series[Index]: IDispatch
Read-only array of DMSerie objects. Index parameter ranges from 0 to SerieCount-1. This property gives you "random access" to plot series.
You also may iterate "for each" cycle on DMPlot object as shown in the example below.
set Plt=Server.ActiveDocument.Plot for I=0 to Plt.SerieCount-1 Plt.Series(I).Text="My serie #" & I next or for each Ser in Server.ActiveDocument.Plot Ser.Text="My serie" next
|function SwapSeries(Serie1, Serie2): VOID
Exchanges two series objects in the Series() array. Serie1 and Serie2 parameters are indices of appropriate serie objects (ranged from 0 to SerieCount-1).
|function DeleteSerie(Serie): VOID
Deletes selected serie object. Serie parameter is a numeric index in the Series() array.
|r/o property XAxis2: IDispatch
|r/o property YAxis2: IDispatch
|property Color: User_Defined
This property should be used to change color of the selected object.
|property MouseMode: User_Defined
MouseMode property for DMDigitizer control select one of the following Digitizer modes: Draw axes frame, Add, Delete or Edit points. Only subset of constants listed in PlotMouseModes enumeration is supported.
For DMPlot, all constants except pmmAddPoints are valid. Use this property to set plot reaction on the mouse clicks programmatically.
|property SelectionVisible: Boolean
Use this property to show or hide plot selection. Plot selection is a rectangular area, indicated by the special frame. Set MouseMode=pmmSelect to change selection coordinates visually, or use Select() method or change SelectionXXX properties. Plot selection used in many operations on the series data.
|function CanUndoZoom: Boolean
This method returns True if UndoZoom operation for given DMPlot object is possible. Use it to monitor controls associated with the "Undo Zoom" command.
|function UndoZoom: VOID
UndoZoom method restores plot coordinates changed by mouse zooming operation. Note that only axes associated with current serie are affected.
|function Save(FileName): VOID
Saves object's data to the selected disk file.
For DMContainer, values are separated by spaces, each item take a separate line. Modified property automatically cleared. In the DMDigitizerContainer object this method not implemented.
DMNotes object just writes editor's text to the disk. DMPlot object saves itself as a metafile picture.
|function Print: VOID
|r/o property Document: IDispatch
Document property returns DMDocument object which is an owner of the given object. So that, you don't need to cycle through the object collections to determine the object's owner. Keep in mind that in DM, VCL objects may be destroyed while appropriate COM objects still alive since their lifecycle is governed by reference counting mechanism. Such COM objects with killed VCL owner become a "zombie" - they have no actual data, their methods do nothing and properties return empty data.
sub TestSerie dim Serie if Server.ActiveDocument is Nothing then MsgBox "NULL document" else set Serie=Server.ActiveDocument.Plot.CurrentSerie MsgBox Serie.Document.WindowCaption end if end sub sub TestAxis dim Axis set Axis=Server.ActiveDocument.Plot.XAxis2 MsgBox Axis.Document.WindowCaption end sub sub TestContainer dim Container set Container=Server.ActiveDocument.Container MsgBox Container.Document.WindowCaption end sub sub TestPlot dim Plot set Plot=Server.ActiveDocument.Plot MsgBox Plot.Document.WindowCaption end sub sub TestWorksheet dim Worksheet set Worksheet=Server.ActiveDocument.Worksheet MsgBox Worksheet.Document.WindowCaption end sub dim Worksheet1 set Worksheet1=Server.ActiveDocument.Worksheet sub TestWorksheet1 MsgBox Worksheet1.Document.WindowCaption end sub dim Serie1 set Serie1=Server.ActiveDocument.Plot.CurrentSerie sub TestSerie1 if Serie1.Document is Nothing then MsgBox "NULL document" else MsgBox Serie1.Document.WindowCaption end if end sub
|r/o property _NewEnum: Unknown
This property returns so-called Enumerator Object. Do not use it explicitly. It is used internally in the "for each [item] in [object]" cycles. Every object that has this property may be enumerated in such a cycles. This is for your convenience.
function EnumDocuments dim S S="" for each Doc in Server S=S & Doc.WindowCaption & vbCrLf next EnumDocuments=S end function function EnumNotes dim S S="" for each Ss in Server.Notes S=S & Ss & vbCrLf next EnumNotes=S end function function EnumSeries dim S S="" for each Ser in Server.ActiveDocument.Plot S=S & Ser.Text & vbCrLf next EnumSeries=S end function function EnumItems dim S S="" for each D in Server.ActiveDocument.Container S=S & D(0) & vbCrLf next EnumItems=S end function
|r/o property Labels: IDispatch
|function CanPaste: Boolean
CanPaste method returns True if clipboard has valid data for PasteFromClipboard method. Use it to monitor controls associated with "Paste" command.
|function PasteFromClipboard(Mode): VOID
For DMDigitizer, this method inserts into the digitizer control the picture from the clipboard.
For DMNotes, PasteFromClipboard operates like in any text editor.
For DMSerie, PasteFromClipboard has a parameter. If DataOnly=True, visual attributes like colors, point size etc. are not assigned. Keep in mind that this method can correctly paste only series copied from the same instance of DM, because it performs search to assign Container.
For DMLabel, this method is just a pair for CopyToClipboard.
For DMPlot, PasteFromClipboard has Mode parameter that determines what data will be pasted; possible values defined in the PlotCopyModes enumeration. Certainly, only series and labels (or both) may be pasted; new objects are created and initialized by data from the clipboard.
For DMWorksheet, this method also has a parameters. Text in the clipboard must contain lines of values separated by spaces, commas or tabstops. Data is pasted from topleft selected cell. If InsertLines is true, new lines will be added, else existing lines will be modified according to second parameter. If Overwrite mode specified, cell contents are replaced else data from clipboard will be inserted at selected position.
For all objects, this method does nothing if there's no suitable data on the clipboard. Use CanPaste method to determine whether clipboard has appropriate data formats.