Class SLWaterfall.TSLWaterfallLayer

From Mitov Wiki Doc

(Difference between revisions)

Jump to: navigation, search

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

Inherits: TSLWaterfall

Syntax

Delphi:

type TSLWaterfallLayer = class( TSLWaterfall )

C++ Builder:

class TSLWaterfallLayer : public TSLWaterfall

Visual C++ (MFC):

class CTSLWaterfallLayer : public CTSLWaterfall

C# (.NET):

public ref class TSLWaterfallLayer : Mitov.PlotLab.Waterfall

Summary

A waterfall draw layer. See Also Defines a waterfall draw layer. You can add this layer to any drawing component such as TVLDraw to render a video layer containing a waterfall. Diagram: <image SLWaterfallLayer_Preview> Example: <image WaterfallLayerSample>

Description

A waterfall draw layer. See Also Defines a waterfall draw layer. You can add this layer to any drawing component such as TVLDraw to render a video layer containing a waterfall. Diagram: Example:

From TSLWaterfall

Properties

Published

Levels - The Levels axis of the Waterfall.
Cursors - Collection of measurement cursors.

Public

ToolTipZValue - Returns the current ToolTip Z value.
DataView - The data view area of the Waterfall.
Data - The waterfall data.

Methods

Public

Pins

InputPin - Input pin for the component.

From TSLBasicWaterfall

Properties

Published

XAxis - The X Axis of the control.
YAxis - The Y Axis of the control.
Legend - The legend area of the control.
CursorLinks - Collection of measurement cursor links.
MarkerGroups - Collection of marker groups.
Labels - Specifies the appearance of the Text labels legend group.
Highlighting - Specifies the highlighting options for the Waterfall.
Vertical - Specifies the Waterfall orientation.

Methods

Public

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

Methods

Public

@@ Line 31: / Line 31: @@
 </code>
 == Summary ==
-A waterfall draw layer.
+A waterfall draw layer. See Also Defines a waterfall draw layer. You can add this layer to any drawing component such as TVLDraw to render a video layer containing a waterfall. <b>Diagram:</b> <image SLWaterfallLayer_Preview> <b>Example:</b> <image WaterfallLayerSample>
 == Description ==
-A waterfall draw layer. See Also Defines a waterfall draw layer. You can add this layer to any drawing component such as TVLDraw to render a video layer containing a waterfall. <b>Example:</b> [[Image:WaterfallLayerSample.png]]
+A waterfall draw layer. See Also Defines a waterfall draw layer. You can add this layer to any drawing component such as TVLDraw to render a video layer containing a waterfall. <b>Diagram:</b> [[Image:SLWaterfallLayer_Preview.png]] <b>Example:</b> [[Image:WaterfallLayerSample.png]]
 == From [[Class SLWaterfall.TSLWaterfall|TSLWaterfall]] ==
@@ Line 42: / Line 42: @@
 === Published ===
 *[[Property SLWaterfall.TSLWaterfall.Levels|Levels]] - The Levels axis of the Waterfall.
+*[[Property SLWaterfall.TSLWaterfall.Cursors|Cursors]] - Collection of measurement cursors.
 === Public ===
@@ Line 51: / Line 52: @@
 === Public ===
+*[[Method function SLWaterfall.TSLWaterfall.GetDataView() : TSLDisplayView|function GetDataView() : TSLDisplayView]]
 *[[Method procedure SLWaterfall.TSLWaterfall.DoColorChannelClick(Integer)|procedure DoColorChannelClick(AItemIndex : Integer)]]
+*[[Method function SLWaterfall.TSLWaterfall.GetCursors() : TSLDisplayCursors|function GetCursors() : TSLDisplayCursors]]
 == Pins ==
@@ Line 61: / Line 64: @@
 === Published ===
-*[[Property SLWaterfall.TSLBasicWaterfall.Title|Title]] - The title area of the control.
 *[[Property SLWaterfall.TSLBasicWaterfall.XAxis|XAxis]] - The X Axis of the control.
 *[[Property SLWaterfall.TSLBasicWaterfall.YAxis|YAxis]] - The Y Axis of the control.
 *[[Property SLWaterfall.TSLBasicWaterfall.Legend|Legend]] - The legend area of the control.
+*[[Property SLWaterfall.TSLBasicWaterfall.CursorLinks|CursorLinks]] - Collection of measurement cursor links.
 *[[Property SLWaterfall.TSLBasicWaterfall.MarkerGroups|MarkerGroups]] - Collection of marker groups.
+*[[Property SLWaterfall.TSLBasicWaterfall.Labels|Labels]] - Specifies the appearance of the Text labels legend group.
 *[[Property SLWaterfall.TSLBasicWaterfall.Highlighting|Highlighting]] - Specifies the highlighting options for the Waterfall.
 *[[Property SLWaterfall.TSLBasicWaterfall.Vertical|Vertical]] - Specifies the Waterfall orientation.
@@ Line 72: / Line 76: @@
 === Public ===
+*[[Method function SLWaterfall.TSLBasicWaterfall.GetHighlightInfo() : TSLHighlightInfo|function GetHighlightInfo() : TSLHighlightInfo]]
+*[[Method function SLWaterfall.TSLBasicWaterfall.GetHighlighting() : TSLDisplayHighlighting|function GetHighlighting() : TSLDisplayHighlighting]]
+*[[Method function SLWaterfall.TSLBasicWaterfall.GetIsVertical() : Boolean|function GetIsVertical() : Boolean]]
 *[[Method procedure SLWaterfall.TSLBasicWaterfall.Print()|procedure Print()]]
 *[[Method procedure SLWaterfall.TSLBasicWaterfall.ZoomTo(Real;Real;Real;Real;Boolean)|procedure ZoomTo(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)]]
@@ Line 83: / Line 90: @@
 === Published ===
 *[[Property SLScope.TSLDataDisplay.Color|Color]] - The color of the display.
+*[[Property SLScope.TSLDataDisplay.Title|Title]] - The title area of the control.
 *[[Property SLScope.TSLDataDisplay.ToolBar|ToolBar]] - The toolbar area of the control.
 *[[Property SLScope.TSLDataDisplay.Zooming|Zooming]] - Specifies the behavior of the zooming.
 *[[Property SLScope.TSLDataDisplay.Cursor|Cursor]]
 *[[Property SLScope.TSLDataDisplay.NavigateMode|NavigateMode]] - Specifies the navigate mode (Zoom or Pan).
+*[[Property SLScope.TSLDataDisplay.Trails|Trails]] - Specifies the settings for the mouse move trails.
 *[[Property SLScope.TSLDataDisplay.Elements|Elements]] - Component elements collection.
 *[[Property SLScope.TSLDataDisplay.RefreshInterval|RefreshInterval]] - Specifies how often the view area will be updated.
@@ Line 101: / Line 110: @@
 *[[Property SLScope.TSLDataDisplay.PlotHeight|PlotHeight]]
 *[[Property SLScope.TSLDataDisplay.Views|Views]]
-*[[Property SLScope.TSLDataDisplay.|Property SLScope.TSLDataDisplay.]]
 == Methods ==
@@ Line 111: / Line 119: @@
 *[[Method procedure SLScope.TSLDataDisplay.Loaded()|procedure Loaded()]]
 *[[Method procedure SLScope.TSLDataDisplay.SetParent(TWinControl)|procedure SetParent(AParent : TWinControl)]]
+*[[Method function SLScope.TSLDataDisplay.GetOperations() : TLPDrawLayerOperations|function GetOperations() : TLPDrawLayerOperations]]
 *[[Method procedure SLScope.TSLDataDisplay.InvalidateRefresh()|procedure InvalidateRefresh()]] - Fully invalidates and flushes the draw caches of the component.
 *[[Method procedure SLScope.TSLDataDisplay.PostRefresh()|procedure PostRefresh()]]
@@ Line 117: / Line 126: @@
 *[[Method function SLScope.TSLDataDisplay.GetAxisValueAt(Integer;Integer;Real;Real) : Boolean|function GetAxisValueAt(X : Integer; Y : Integer; var AxisX : Real; var AxisY : Real) : Boolean]] - Returns the X and Y axis value at a mouse point.
 *[[Method procedure SLScope.TSLDataDisplay.GetChildren(TGetChildProc;TComponent)|procedure GetChildren(Proc : TGetChildProc; Root : TComponent)]]
+*[[Method function SLScope.TSLDataDisplay.GetHighlightInfo() : TSLHighlightInfo|function GetHighlightInfo() : TSLHighlightInfo]]
+*[[Method function SLScope.TSLDataDisplay.GetHighlighting() : TSLDisplayHighlighting|function GetHighlighting() : TSLDisplayHighlighting]]
+*[[Method function SLScope.TSLDataDisplay.GetCursors() : TSLDisplayCursors|function GetCursors() : TSLDisplayCursors]]
 *[[Method procedure SLScope.TSLDataDisplay.Print()|procedure Print()]] - Prints the display.
 *[[Method procedure SLScope.TSLDataDisplay.CopyToClipboard()|procedure CopyToClipboard()]] - Copies the content of the display to the Clipboard.
 *[[Method procedure SLScope.TSLDataDisplay.SaveToBitmap(String)|procedure SaveToBitmap(FileName : String)]] - Saves snapshot of the display into a bitmap file.
 *[[Method procedure SLScope.TSLDataDisplay.SaveToJpeg(String)|procedure SaveToJpeg(FileName : String)]] - Saves snapshot of the display into a JPEG file.
+*[[Method function SLScope.TSLDataDisplay.GetDataView() : TSLDisplayView|function GetDataView() : TSLDisplayView]]
+*[[Method function SLScope.TSLDataDisplay.GetIsVertical() : Boolean|function GetIsVertical() : Boolean]]
+*[[Method function SLScope.TSLDataDisplay.GetColorChannelIndex(TSLDisplayView) : Integer|function GetColorChannelIndex(AView : TSLDisplayView) : Integer]]
 *[[Method procedure SLScope.TSLDataDisplay.DoColorChannelClick(Integer)|procedure DoColorChannelClick(AItemIndex : Integer)]]
 *[[Method procedure SLScope.TSLDataDisplay.DoLayerDraw(TLPCanvas;Integer;Integer;Single;Single;Boolean)|procedure DoLayerDraw(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single; AContoursOnly : Boolean)]]
@@ Line 139: / Line 154: @@
 *[[Event SLScope.TSLDataDisplay.OnZoomChanged|OnZoomChanged]] - Occurs when the zoom has been changed.
 *[[Event SLScope.TSLDataDisplay.OnDataToolTip|OnDataToolTip]] - Occurs when the data tool tip will be shown or updated.
+*[[Event SLScope.TSLDataDisplay.OnPaint|OnPaint]] - Occurs when the control is redrawn.
 *[[Event SLScope.TSLDataDisplay.OnKeyDown|OnKeyDown]]
 *[[Event SLScope.TSLDataDisplay.OnKeyPress|OnKeyPress]]
@@ Line 147: / Line 163: @@
 *[[Event SLScope.TSLDataDisplay.OnMouseMove|OnMouseMove]]
 *[[Event SLScope.TSLDataDisplay.OnMouseUp|OnMouseUp]]
-== From [[Class LPControlDrawLayers.TLPControlDrawLayer|TLPControlDrawLayer]] ==
-== Methods ==
-=== Public ===
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerBegin(TLPCanvas;Integer;Integer;Single;Single)|procedure DoLayerBegin(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single)]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerEnd()|procedure DoLayerEnd()]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerDraw(TLPCanvas;Integer;Integer;Single;Single;Boolean)|procedure DoLayerDraw(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single; AContoursOnly : Boolean)]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseMove(TShiftState;Integer;Integer)|procedure DoLayerMouseMove(AShift : TShiftState; AX : Integer; AY : Integer)]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseDown(TMouseButton;TShiftState;Integer;Integer)|procedure DoLayerMouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer)]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseUp(TMouseButton;TShiftState;Integer;Integer)|procedure DoLayerMouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer)]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseWheelDown(TShiftState;Integer;Integer)|procedure DoLayerMouseWheelDown(AShift : TShiftState; AX : Integer; AY : Integer)]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseWheelUp(TShiftState;Integer;Integer)|procedure DoLayerMouseWheelUp(AShift : TShiftState; AX : Integer; AY : Integer)]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseEnter()|procedure DoLayerMouseEnter()]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseLeave()|procedure DoLayerMouseLeave()]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.SetChachedData(TObject;TObject)|procedure SetChachedData(ALink : TObject; AData : TObject)]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.AddLayerLink(TLPLayerCollectionItem)|procedure AddLayerLink(ALink : TLPLayerCollectionItem)]]
-*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.RemoveLayerLink(TLPLayerCollectionItem)|procedure RemoveLayerLink(ALink : TLPLayerCollectionItem)]]
 == From [[Class SLControlCollection.TSLCustomControlItem|TSLCustomControlItem]] ==
@@ Line 178: / Line 175: @@
 === Public ===
+*[[Method function SLControlCollection.TSLCustomControlItem.GetParentComponent() : TComponent|function GetParentComponent() : TComponent]]
+*[[Method function SLControlCollection.TSLCustomControlItem.HasParent() : Boolean|function HasParent() : Boolean]]
 *[[Method procedure SLControlCollection.TSLCustomControlItem.SetParent(TWinControl)|procedure SetParent(AParent : TWinControl)]]
 *[[Method function SLControlCollection.TSLCustomControlItem.GetHasEnable() : Boolean|function GetHasEnable() : Boolean]]
 *[[Method function SLControlCollection.TSLCustomControlItem.GetCanDisable() : Boolean|function GetCanDisable() : Boolean]]
 *[[Method procedure SLControlCollection.TSLCustomControlItem.SetParentComponent(TComponent)|procedure SetParentComponent(AValue : TComponent)]]
-== From [[Class LPControl.TLPCustomControl|TLPCustomControl]] ==
-== Properties ==
-=== Published ===
-*[[Property LPControl.TLPCustomControl.Visible|Visible]]
-== Methods ==
-=== Public ===
-*[[Method procedure LPControl.TLPCustomControl.InvalidateIntRect(TRect)|procedure InvalidateIntRect(ARect : TRect)]]
-== Events ==
-*[[Event LPControl.TLPCustomControl.OnMouseEnter|OnMouseEnter]]
-*[[Event LPControl.TLPCustomControl.OnMouseLeave|OnMouseLeave]]
 [[Category:Layers]][[Category:Classes]]

Class SLWaterfall.TSLWaterfallLayer

Revision as of 20:29, 10 June 2013

Contents

Syntax

Delphi:

C++ Builder:

Visual C++ (MFC):

C# (.NET):

Summary

Description

From TSLWaterfall

Properties

Published

Public

Methods

Public

Pins

From TSLBasicWaterfall

Properties

Published

Methods

Public

From TSLDataDisplay

Properties

Published

Public

Methods

Public

Events

From TSLCustomControlItem

Properties

Public

Methods

Public

Personal tools

Namespaces

Variants

Views

Actions

Search

Navigation

Toolbox