Class SLScope.TSLExternalScopeMatrixLayer

---

Revision as of 00:20, 22 November 2011

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: TSLExternalScopeElement

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 From TSLExternalScopeElement 5 Properties 5.1 Published 6 Methods 6.1 Public 7 From TSLScope 8 Properties 8.1 Published 9 Methods 9.1 Public 10 Events 11 From TSLDataChart 12 Properties 12.1 Published 13 Methods 13.1 Public 14 PinLists 15 Events 16 From TSLDataDisplay 17 Properties 17.1 Published 17.2 Public 18 Methods 18.1 Public 19 Events 20 From TLPControlDrawLayer 21 Methods 21.1 Public 22 From TSLCustomControlItem 23 Properties 23.1 Public 24 Methods 24.1 Public 25 From TLPCustomControl 26 Properties 26.1 Published 27 Methods 27.1 Public 28 Events

Syntax

Delphi:

type TSLExternalScopeMatrixLayer = class( TSLExternalScopeElement, ILPMatrixComponentElement )

C++ Builder:

class TSLExternalScopeMatrixLayer : public TSLExternalScopeElement

Visual C++ (MFC):

class CTSLExternalScopeMatrixLayer : public CTSLExternalScopeElement

C# (.NET):

public ref class TSLExternalScopeMatrixLayer : Mitov.PlotLab.ExternalScopeElement

Summary

A scope matrix component layer.

Description

Add this matrix component layer to draw scope in a matrix.

Example:

From TSLExternalScopeElement

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.
• MarkerGroups - Collection of marker groups.
• Channels - Collection of scope channels.
• Zones - Collection of display zones.
• Ellipses - Collection of display elliptic zones.
• Cursors - Collection of measurement cursors.
• CursorLinks - Collection of measurement cursor links.
• ChannelLinks - Collection of scope channel links.
• SizeLimit - Sets the limit of samples per channel.
• Labels - Collection of display labels.

Methods

Public

• procedure Invalidate() - Invalidates the visible area of the Scope.
• 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.
• Title - The title area of the control.
• DataView - The data view area of the component.
• Trails - Specifies the settings for the muse move trails.
• Highlighting - Specifies the highlighting options.
• CursorsStayInView - Specifies if the cursors will remain within the view.

Methods

Public

• 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.
• ToolBar - The toolbar area of the control.
• Zooming - Specifies the behavior of the zooming.
• Cursor
• NavigateMode - Specifies the navigate mode (Zoom or Pan).
• 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
• [[Property SLScope.TSLDataDisplay.|]]

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)
• 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)
• 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.
• 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.
• OnKeyDown
• OnKeyPress
• OnKeyUp
• OnClick
• OnDblClick
• OnMouseDown
• OnMouseMove
• OnMouseUp

From TLPControlDrawLayer

Methods

Public

• procedure DoLayerBegin(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single)
• procedure DoLayerEnd()
• procedure DoLayerDraw(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single; AContoursOnly : Boolean)
• procedure DoLayerMouseMove(AShift : TShiftState; AX : Integer; AY : Integer)
• procedure DoLayerMouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer)
• procedure DoLayerMouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer)
• procedure DoLayerMouseWheelDown(AShift : TShiftState; AX : Integer; AY : Integer)
• procedure DoLayerMouseWheelUp(AShift : TShiftState; AX : Integer; AY : Integer)
• procedure DoLayerMouseEnter()
• procedure DoLayerMouseLeave()
• procedure SetChachedData(ALink : TObject; AData : TObject)
• procedure AddLayerLink(ALink : TLPLayerCollectionItem)
• procedure RemoveLayerLink(ALink : TLPLayerCollectionItem)

From TSLCustomControlItem

Properties

Public

• Index
• ComponentList

Methods

Public

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

From TLPCustomControl

Properties

Published

• Visible

Methods

Public

• procedure InvalidateIntRect(ARect : TRect)

Events

• OnMouseEnter
• OnMouseLeave