Class SLScope.TSLDataDisplay

Revision as of 20:29, 10 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: TLPControlDrawLayer

Syntax

Delphi:

type TSLDataDisplay = class( TLPControlDrawLayer, IULBasicControl )

C++ Builder:

class TSLDataDisplay : public TLPControlDrawLayer

Visual C++ (MFC):

class CTSLDataDisplay : public CTLPControlDrawLayer

C# (.NET):

public ref class TSLDataDisplay : Mitov.PlotLab.ControlDrawLayer

Summary

Basic abstract class for visual data displays.

Description

This is a base class for visual data displays such as Scopes and Spectrum Analyzers. Do not make instances of this class. Instead create instance of an inherited class.

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)