IDMSerie Interface

Version: 1.0
Dispatch interface for DMSerie Object

GUID: {673A9FE3-9A0B-11D4-B2A4-FD6847C75367}

IDMSerie interface implemented only for backward compatibility with DM2000. Use IDMSerie3 interface instead.

Members:
Kind Name ID Description
IsRecording 1 Change TDataForm.IsRecordingSerie[]
IsFunction 2 Change TSerie.IsFunction
IsEmpty 3 Return TSerie.Empty
ClearSelection 4 Invoke TSerie.ClearBlock()
XColumn 5 Change TSerie.XColumn
YColumn 6 Change TSerie.YColumn
FirstLine 7 Change TSerie.FirstLine
LastLine 8 Change TSerie.LastLine
Select 9 Set serie block (container data range)
XExpression 10 Change TSerie.XExpression
YExpression 11 Change TSerie.YExpression
Text 12 Change TSerie.Text
Container 13 Change TSerie.Container
AddPoint 14 Add and draw point without plot refresh
GetPoint 15 Return X,Y coordinates with all calculations

Syntax:
property IsRecording: Boolean

Applies to:
DMDocument, DMSerie

For DMDocument, this property indicates whether appropriate data window is in the "recording" state, that is, used for recording data from the measurement system (or for another real-time data streaming). Such window has a thick colored frame. Besides, "recording" data window is not only a visual feedback - it doesn't refresh plot when you set Container.Modified=true, and doesn't refresh Series Manager when you set Container.Modified=false (although worksheet updates its size). This feature should be used to eliminate flickers and significantly increase data streaming rates (and reduce CPU load). In addition, value of this property analyzed in the IDMApplication.RecordPoint() method.

For DMSerie, this property reflects the fact that this series is used to display accumulated data. When it is set to True, a little cross is displayed at the last point. Set IsRecording property to indicate that you are adding points into this series.

Syntax:
property IsFunction: Boolean

Applies to:
DMSerie

If this property is true, the serie is functional, that is, it can display curve given by symbolic expression rather than numeric data. X and Y expressions depend on "cx" parameter, ranged from Min to Max.

In DM2003, when you set IsRecording=True, XExpression automatically initialized with "cx" value, Min and Max are set to the X axis range, number of points, line and point visibility flags also initialized for compatibility with DM2000.

Syntax:
r/o property IsEmpty: Boolean

Applies to:
DMSerie

Read this property to determine whether given serie is empty. Empty series are not displayed. Serie treated as empty if any components of the data range are not defined: for example, X, YColumn is 0 or LastLine is -1.

Use ClearSelection method to make the serie empty.

Syntax:
function ClearSelection: VOID

Applies to:
DMSerie

This procedure simply set XCol=YCol=FirstLine=0, LastLine=-1. Serie become "empty" and not displayed.

Syntax:
property XColumn: Long

Applies to:
DMSerie, DMWorksheet

For DMSerie, XColumn is a part of the serie's data range. It must be greater than 1; for functional series, however, it is not used and may be zero.

For DMWorksheet, this property determines what column is treated as "X". Unlike in spreadsheet processors, many operations in DM2003 require a range of lines and position of X and/or Y columns. As well as with UI, you can set these values programmatically.

Syntax:
property YColumn: Long

Applies to:
DMSerie, DMWorksheet

For DMSerie, YColumn is a part of the serie's data range. It must be greater than 1; for functional series, however, it is not used and may be zero.

For DMWorksheet, this property determines what column is treated as "Y". Unlike in spreadsheet processors, many operations in DM2003 require a range of lines and position of X and/or Y columns. As well as with UI, you can set these values programmatically.

Syntax:
property FirstLine: Long

Applies to:
DMSerie

This property determines index of the first data element in the DMContainer object associated with given serie. If FirstLine is less than 0 or greater than LastLine, data range of the serie is invalid and serie is not displayed.

For functional series, LastLine-FirstLine residual determines the number of intervals.

Syntax:
property LastLine: Long

Applies to:
DMSerie

This property determines index of the last data element in the DMContainer object associated with given serie. If LastLine is less than 0 or less than FirstLine, data range of the serie is invalid and serie is not displayed.

For functional series, LastLine-FirstLine residual determines the number of intervals.

Syntax:
function Select(XCol, YCol, First, Last): VOID

Applies to:
DMLabel, DMNotes, DMPlot, DMSerie, DMWorksheet

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.

Syntax:
property XExpression: BSTR

Applies to:
DMSerie

Expressions allows you to transform your data "on-fly", and are of the most prominent features of DM2003 graphic engine. Besides, expressions are used in so-called "functional", or parameterized, series. See details about expression syntax and allowed arguments and function names.

Syntax:
property YExpression: BSTR

Applies to:
DMSerie

Expressions allows you to transform your data "on-fly", and are of the most prominent features of DM2003 graphic engine. Besides, expressions are used in so-called "functional", or parameterized, series. See details about expression syntax and allowed arguments and function names.

Syntax:
property Text: BSTR

Applies to:
B740X, DMComboBox, DMExpressionComboBox, DMFloatEdit, DMLabel, DMListBox, DMListItems, DMNotes, DMSerie, DMSpinEdit, DMStrings, E712X, HP4191X

For DMForms ActiveX controls (DMComboBox, DMExpressionComboBox, DMListBox, DMFloatEdit, DMSpinEdit) this property changes the text in the appropriate control.

For collection objects (DMListItems, DMStrings), this property represents the contents of the collection as a single block of text. Lines are separated by standard CRLF characters.

For DMNotes, this property also operates with the editor's data as a whole.

For DMSerie and DMLabel objects, Text is just a label.

For device driver ActiveX controls (HP4191X, B740X and E712X) this property should be used to read and write data from/to the device.

Syntax:
property Container: IDispatch

Applies to:
DMDigitizer, DMDocument, DMSerie

For DMDocument and DMSerie objects, Container property returns reference to the associated DMContainer object. Notice that for DMSerie object, this property is read/write, that is, you can assign to it container of any document.

For DMDigitizer, this property returns reference to the DMDigitizerContainer object, which is used only to store points coordinates.

Syntax:
function AddPoint: VOID

Applies to:
DMSerie

Syntax:
function GetPoint(Index, X, Y): VOID

Applies to:
DMSerie