Class SLScope.TSLExternalScopeElement

Revision as of 02:45, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit

Revision as of 23:53, 25 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) Newer edit →

---

Revision as of 23:53, 25 June 2013

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Package: SignalLabScopePkg

Unit: SLScope

Inherits: TSLScope

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Properties 4.1 Published 5 Methods 5.1 Public 6 From TSLScope 7 Properties 7.1 Published 8 Methods 8.1 Public 9 Events 10 From TSLDataChart 11 Properties 11.1 Published 12 Methods 12.1 Public 13 PinLists 14 Events 15 From TSLDataDisplay 16 Properties 16.1 Published 16.2 Public 17 Methods 17.1 Public 18 Events 19 From TSLCustomControlItem 20 Properties 20.1 Public 21 Methods 21.1 Public

Syntax

Delphi:

type TSLExternalScopeElement = class( TSLScope, ILPComponentElement, ILPDrawComponentElement )

C++ Builder:

class TSLExternalScopeElement : public TSLScope

Visual C++ (MFC):

class CTSLExternalScopeElement : public CTSLScope

C# (.NET):

public ref class TSLExternalScopeElement : Mitov.PlotLab.Scope

Summary

A scope component element.

Description

Add this component element to draw scope in a control.

Diagram:

Example:

Properties

Published

• Position - Specifies the position of the component element.
• Size - Specifies the size of the component element.

Methods

Public

• procedure Draw(AGraphics : IGPGraphics; AContoursOnly : Boolean; ARadiusX : Single; ARadiusY : Single; Width : Single; Height : Single; AXCoeff : Single; AYCoeff : Single)
• procedure InvalidateSize()
• procedure Invalidate()

From TSLScope

Properties

Published

• Vertical - Specifies the Scope orientation.
• Channels - Collection of scope channels.
• ChannelLinks - Collection of scope channel links.
• Cursors - Collection of measurement cursors.
• CursorLinks - Collection of measurement cursor links.
• MarkerGroups - Collection of marker groups.
• Zones - Collection of display zones.
• Ellipses - Collection of display elliptic zones.
• Labels - Collection of display labels.
• SizeLimit - Sets the limit of samples per channel.

Methods

Public

• procedure Invalidate() - Invalidates the visible area of the Scope.
• function GetIsVertical() : Boolean
• procedure SetLabelText(AValue : PChar)
• procedure Print()
• procedure Loaded()

Events

• OnCustomMouseHitLabel - Occurs when the mouse hit label is in about to be painted.

From TSLDataChart

Properties

Published

• YAxis - The Y Axis of the control.
• XAxis - The X Axis of the control.
• Legend - The legend area of the control.
• DataView - The data view area of the component.
• Highlighting - Specifies the highlighting options.
• CursorsStayInView - Specifies if the cursors will remain within the view.

Methods

Public

• function GetHighlightInfo() : TSLHighlightInfo
• function GetHighlighting() : TSLDisplayHighlighting
• function GetCursors() : TSLDisplayCursors
• function GetDataView() : TSLDisplayView
• procedure ZoomBy(XValue : Real; YValue : Real; SaveHistory : Boolean)
• procedure ZoomTo(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)
• procedure ZoomToData(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)

PinLists

• InputPins - The Y input pins for the component.
• XInputPins - The X input pins for the component.

Events

• OnOverChannel - Occurs when the mouse has been moved over a scope channel.
• OnLeaveChannel - Occurs when the mouse leaves the area above a scope channel.

From TSLDataDisplay

Properties

Published

• Color - The color of the display.
• Title - The title area of the control.
• ToolBar - The toolbar area of the control.
• Zooming - Specifies the behavior of the zooming.
• Cursor
• NavigateMode - Specifies the navigate mode (Zoom or Pan).
• Trails - Specifies the settings for the mouse move trails.
• Elements - Component elements collection.
• RefreshInterval - Specifies how often the view area will be updated.
• Visible - Specifies if the control will be visible.
• TabStop

Public

• CanRedoZoom - Can Redo the Zoom.
• CanUndoZoom - Can Undo the Zoom.
• CanZoomOut - Can Zoom In.
• CanZoomIn - Can Zoom In.
• Hold - Holds (freezes) the samples on the component.
• PlotWidth
• PlotHeight
• Views

Methods

Public

• procedure SetToolTipText(AValue : PChar) - Provides a new ToolTip Text value( Visual C++ (MFC/Win32) only ).
• function GetToolTipText() : String - Returns the current tooltip text (Visual C++ only).
• procedure SetBounds(ALeft : Integer; ATop : Integer; AWidth : Integer; AHeight : Integer)
• procedure Loaded()
• procedure SetParent(AParent : TWinControl)
• function GetOperations() : TLPDrawLayerOperations
• procedure InvalidateRefresh() - Fully invalidates and flushes the draw caches of the component.
• procedure PostRefresh()
• procedure RefreshView() - Repaints the component with the most current data.
• procedure CopyToBitmap(ABitmap : TBitmap) - Copies the content of the display to a Bitmap.
• function GetAxisValueAt(X : Integer; Y : Integer; var AxisX : Real; var AxisY : Real) : Boolean - Returns the X and Y axis value at a mouse point.
• procedure GetChildren(Proc : TGetChildProc; Root : TComponent)
• function GetHighlightInfo() : TSLHighlightInfo
• function GetHighlighting() : TSLDisplayHighlighting
• function GetCursors() : TSLDisplayCursors
• procedure Print() - Prints the display.
• procedure CopyToClipboard() - Copies the content of the display to the Clipboard.
• procedure SaveToBitmap(FileName : String) - Saves snapshot of the display into a bitmap file.
• procedure SaveToJpeg(FileName : String) - Saves snapshot of the display into a JPEG file.
• function GetDataView() : TSLDisplayView
• function GetIsVertical() : Boolean
• function GetColorChannelIndex(AView : TSLDisplayView) : Integer
• procedure DoColorChannelClick(AItemIndex : Integer)
• procedure DoLayerDraw(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single; AContoursOnly : Boolean)
• procedure ZoomOff() - Turns the zoom off.
• procedure ZoomBy(AValue : Real)
• procedure ZoomBy(AValue : Real; SaveHistory : Boolean)
• procedure ZoomBy(XValue : Real; YValue : Real)
• procedure ZoomBy(XValue : Real; YValue : Real; SaveHistory : Boolean)
• procedure ZoomTo(XMin : Real; XMax : Real; YMin : Real; YMax : Real) - Zooms to show the range between XMin, XMax, YMin and YMax.
• procedure ZoomTo(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean) - Zooms to show the range between XMin, XMax, YMin and YMax. Allows optionally the zoom history to be saved for Undo.
• procedure ZoomToData(XMin : Real; XMax : Real; YMin : Real; YMax : Real) - Zooms to show the range between XMin, XMax, YMin and YMax based on the data scaling.
• procedure ZoomToData(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean) - Zooms to show the range between XMin, XMax, YMin and YMax based on the data scaling. Allows optionally the zoom history to be saved for Undo.
• procedure UndoZoom() - Restores the zoom to previous values.
• procedure RedoZoom() - Restores to a zoom that has been used before the last UndoZoom.
• procedure ClearZoomUndo() - Clears all the ZoomUndo and ZoomRedo history.

Events

• OnZoomChanged - Occurs when the zoom has been changed.
• OnDataToolTip - Occurs when the data tool tip will be shown or updated.
• OnPaint - Occurs when the control is redrawn.
• OnKeyDown
• OnKeyPress
• OnKeyUp
• OnClick
• OnDblClick
• OnMouseDown
• OnMouseMove
• OnMouseUp

From TSLCustomControlItem

Properties

Public

• Index
• ComponentList

Methods

Public

• function GetParentComponent() : TComponent
• function HasParent() : Boolean
• procedure SetParent(AParent : TWinControl)
• function GetHasEnable() : Boolean
• function GetCanDisable() : Boolean
• procedure SetParentComponent(AValue : TComponent)