Class SLWaterfall.TSLExternalWaterfallElement
From Mitov Wiki Doc
(Difference between revisions)
(Automated Syncronization with Documentation) |
(Automated Syncronization with Documentation) |
Revision as of 00:11, 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.
Package: SignalLabScopePkg
Unit: SLWaterfall
Inherits: TSLWaterfall
Contents |
Syntax
Delphi:
type TSLExternalWaterfallElement = class( TSLWaterfall, ILPComponentElement, ILPDrawComponentElement )
C++ Builder:
class TSLExternalWaterfallElement : public TSLWaterfall
Visual C++ (MFC):
class CTSLExternalWaterfallElement : public CTSLWaterfall
C# (.NET):
public ref class TSLExternalWaterfallElement : Mitov.PlotLab.Waterfall
Summary
A waterfall component element.
Description
Add this component element to draw waterfall in a control.
Diagram:
Example:
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 TSLWaterfall
Properties
Published
Public
- ToolTipZValue - Returns the current ToolTip Z value.
- DataView - The data view area of the Waterfall.
- Data - The waterfall data.
Methods
Public
- function GetDataView() : TSLDisplayView
- procedure DoColorChannelClick(AItemIndex : Integer)
- function GetCursors() : TSLDisplayCursors
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
- function GetHighlightInfo() : TSLHighlightInfo
- function GetHighlighting() : TSLDisplayHighlighting
- function GetIsVertical() : Boolean
- 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.
- 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