Class SLWaterfall.TSLWaterfall

From Mitov Wiki Doc
(Difference between revisions)
Jump to: navigation, search
(Automated Syncronization with Documentation)
 
(Automated Syncronization with Documentation)
 
(6 intermediate revisions by one user not shown)
Line 28: Line 28:
 
=== C# (.NET): ===
 
=== C# (.NET): ===
 
<code>
 
<code>
'''public ref class''' TSLWaterfall : [[Class SLWaterfall.TSLBasicWaterfall|Mitov.PlotLab.BasicWaterfall]]
+
'''public ref class''' Waterfall : [[Class SLWaterfall.TSLBasicWaterfall|Mitov.PlotLab.BasicWaterfall]]
 
</code>
 
</code>
 
== Summary ==
 
== Summary ==
Line 36: Line 36:
 
Use this component to visualize floating point data as
 
Use this component to visualize floating point data as
 
waterfall.
 
waterfall.
 +
 +
 +
 +
<b>Diagram:</b>
 +
 +
[[Image:SLWaterfall_Preview.png]]
  
  
Line 59: Line 65:
 
=== Published ===
 
=== Published ===
 
*[[Property SLWaterfall.TSLWaterfall.Levels|Levels]] - The Levels axis of the Waterfall.  
 
*[[Property SLWaterfall.TSLWaterfall.Levels|Levels]] - The Levels axis of the Waterfall.  
 +
*[[Property SLWaterfall.TSLWaterfall.Cursors|Cursors]] - Collection of measurement cursors.
  
 
=== Public ===
 
=== Public ===
Line 68: Line 75:
  
 
=== Public ===
 
=== Public ===
 +
*[[Method function SLWaterfall.TSLWaterfall.GetDataView() : TSLDisplayView|function GetDataView() : TSLDisplayView]]
 
*[[Method procedure SLWaterfall.TSLWaterfall.DoColorChannelClick(Integer)|procedure DoColorChannelClick(AItemIndex : Integer)]]
 
*[[Method procedure SLWaterfall.TSLWaterfall.DoColorChannelClick(Integer)|procedure DoColorChannelClick(AItemIndex : Integer)]]
 +
*[[Method function SLWaterfall.TSLWaterfall.GetCursors() : TSLDisplayCursors|function GetCursors() : TSLDisplayCursors]]
  
 
== Pins ==
 
== Pins ==
Line 78: Line 87:
  
 
=== Published ===
 
=== 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.XAxis|XAxis]] - The X Axis of the control.  
 
*[[Property SLWaterfall.TSLBasicWaterfall.YAxis|YAxis]] - The Y 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.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.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.Highlighting|Highlighting]] - Specifies the highlighting options for the Waterfall.  
 
*[[Property SLWaterfall.TSLBasicWaterfall.Vertical|Vertical]] - Specifies the Waterfall orientation.  
 
*[[Property SLWaterfall.TSLBasicWaterfall.Vertical|Vertical]] - Specifies the Waterfall orientation.  
Line 89: Line 99:
  
 
=== Public ===
 
=== 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.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)]]
 
*[[Method procedure SLWaterfall.TSLBasicWaterfall.ZoomTo(Real;Real;Real;Real;Boolean)|procedure ZoomTo(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)]]
Line 100: Line 113:
 
=== Published ===
 
=== Published ===
 
*[[Property SLScope.TSLDataDisplay.Color|Color]] - The color of the display.  
 
*[[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.ToolBar|ToolBar]] - The toolbar area of the control.  
 
*[[Property SLScope.TSLDataDisplay.Zooming|Zooming]] - Specifies the behavior of the zooming.  
 
*[[Property SLScope.TSLDataDisplay.Zooming|Zooming]] - Specifies the behavior of the zooming.  
 
*[[Property SLScope.TSLDataDisplay.Cursor|Cursor]]
 
*[[Property SLScope.TSLDataDisplay.Cursor|Cursor]]
 
*[[Property SLScope.TSLDataDisplay.NavigateMode|NavigateMode]] - Specifies the navigate mode (Zoom or Pan).  
 
*[[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.Elements|Elements]] - Component elements collection.  
 
*[[Property SLScope.TSLDataDisplay.RefreshInterval|RefreshInterval]] - Specifies how often the view area will be updated.  
 
*[[Property SLScope.TSLDataDisplay.RefreshInterval|RefreshInterval]] - Specifies how often the view area will be updated.  
Line 118: Line 133:
 
*[[Property SLScope.TSLDataDisplay.PlotHeight|PlotHeight]]
 
*[[Property SLScope.TSLDataDisplay.PlotHeight|PlotHeight]]
 
*[[Property SLScope.TSLDataDisplay.Views|Views]]
 
*[[Property SLScope.TSLDataDisplay.Views|Views]]
*[[Property SLScope.TSLDataDisplay.|]]
 
  
 
== Methods ==
 
== Methods ==
Line 128: Line 142:
 
*[[Method procedure SLScope.TSLDataDisplay.Loaded()|procedure Loaded()]]
 
*[[Method procedure SLScope.TSLDataDisplay.Loaded()|procedure Loaded()]]
 
*[[Method procedure SLScope.TSLDataDisplay.SetParent(TWinControl)|procedure SetParent(AParent : TWinControl)]]
 
*[[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.InvalidateRefresh()|procedure InvalidateRefresh()]] - Fully invalidates and flushes the draw caches of the component.  
 
*[[Method procedure SLScope.TSLDataDisplay.PostRefresh()|procedure PostRefresh()]]
 
*[[Method procedure SLScope.TSLDataDisplay.PostRefresh()|procedure PostRefresh()]]
Line 134: Line 149:
 
*[[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 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 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.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.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.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 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.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)]]
 
*[[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 156: Line 177:
 
*[[Event SLScope.TSLDataDisplay.OnZoomChanged|OnZoomChanged]] - Occurs when the zoom has been changed.  
 
*[[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.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.OnKeyDown|OnKeyDown]]
 
*[[Event SLScope.TSLDataDisplay.OnKeyPress|OnKeyPress]]
 
*[[Event SLScope.TSLDataDisplay.OnKeyPress|OnKeyPress]]
Line 164: Line 186:
 
*[[Event SLScope.TSLDataDisplay.OnMouseMove|OnMouseMove]]
 
*[[Event SLScope.TSLDataDisplay.OnMouseMove|OnMouseMove]]
 
*[[Event SLScope.TSLDataDisplay.OnMouseUp|OnMouseUp]]
 
*[[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]] ==
 
== From [[Class SLControlCollection.TSLCustomControlItem|TSLCustomControlItem]] ==
Line 195: Line 198:
  
 
=== Public ===
 
=== 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 procedure SLControlCollection.TSLCustomControlItem.SetParent(TWinControl)|procedure SetParent(AParent : TWinControl)]]
 
*[[Method function SLControlCollection.TSLCustomControlItem.GetHasEnable() : Boolean|function GetHasEnable() : Boolean]]
 
*[[Method function SLControlCollection.TSLCustomControlItem.GetHasEnable() : Boolean|function GetHasEnable() : Boolean]]
 
*[[Method function SLControlCollection.TSLCustomControlItem.GetCanDisable() : Boolean|function GetCanDisable() : Boolean]]
 
*[[Method function SLControlCollection.TSLCustomControlItem.GetCanDisable() : Boolean|function GetCanDisable() : Boolean]]
 
*[[Method procedure SLControlCollection.TSLCustomControlItem.SetParentComponent(TComponent)|procedure SetParentComponent(AValue : TComponent)]]
 
*[[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:Controls]][[Category:Classes]]
 
[[Category:Controls]][[Category:Classes]]

Latest revision as of 00:30, 26 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.

BIGSLWaterfall.gif SLWaterfall.gif NETSLWaterfall.gif

Package: SignalLabScopePkg

Unit: SLWaterfall

Inherits: TSLBasicWaterfall

Contents

Syntax

Delphi:

type TSLWaterfall = class( TSLBasicWaterfall )

C++ Builder:

class TSLWaterfall : public TSLBasicWaterfall

Visual C++ (MFC):

class CTSLWaterfall : public CTSLBasicWaterfall

C# (.NET):

public ref class Waterfall : Mitov.PlotLab.BasicWaterfall

Summary

Visible waterfall for representing Real(double) data.

Description

Use this component to visualize floating point data as waterfall.


Diagram:

SLWaterfall Preview.png


Example:

SampleSLWaterfall.png


In Visual C++ you can instantiate the component by using the Open method:

  VCL_InitControls( m_hWnd ); // Call this function once before creating any visual controls!

  CTSLWaterfall SLWaterfall;
  SLWaterfall.Open( m_WaterfallDisplay.m_hWnd );

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
Actions
Navigation
Toolbox