Class SLWaterfall.TSLBasicWaterfall

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

Inherits: TSLDataDisplay

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 TSLDataDisplay 7 Properties 7.1 Published 7.2 Public 8 Methods 8.1 Public 9 Events 10 From TLPControlDrawLayer 11 Methods 11.1 Public 12 From TSLCustomControlItem 13 Properties 13.1 Public 14 Methods 14.1 Public 15 From TLPCustomControl 16 Properties 16.1 Published 17 Methods 17.1 Public 18 Events

Syntax

Delphi:

type TSLBasicWaterfall = class( TSLDataDisplay )

C++ Builder:

class TSLBasicWaterfall : public TSLDataDisplay

Visual C++ (MFC):

class CTSLBasicWaterfall : public CTSLDataDisplay

C# (.NET):

public ref class TSLBasicWaterfall : Mitov.PlotLab.DataDisplay

Summary

Basic abstract class for Waterfall type displays.

Description

This is a base class for visual data Waterfall displays. Do not make instances of this class. Instead create instance of an inherited class.

Properties

Published

• Title - The title area of the control.
• XAxis - The X Axis of the control.
• YAxis - The Y Axis of the control.
• Legend - The legend area of the control.
• MarkerGroups - Collection of marker groups.
• Highlighting - Specifies the highlighting options for the Waterfall.
• Vertical - Specifies the Waterfall orientation.

Methods

Public

• procedure Print()
• procedure ZoomTo(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)
• procedure ZoomToData(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)
• procedure ZoomBy(XValue : Real; YValue : Real; SaveHistory : Boolean)

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