Class PLMultiWaterfall.TPLExternalMultiWaterfallElement
From Mitov Wiki Doc
(Difference between revisions)
(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''' | + | '''public ref class''' ExternalMultiWaterfallElement : [[Class PLMultiWaterfall.TPLMultiWaterfallLayer|Mitov.PlotLab.MultiWaterfallLayer]] |
</code> | </code> | ||
== Summary == | == Summary == | ||
Line 35: | Line 35: | ||
== Description == | == Description == | ||
Add this component element to draw scope in a control. | Add this component element to draw scope in a control. | ||
+ | |||
+ | |||
+ | |||
+ | <b>Diagram:</b> | ||
+ | |||
+ | [[Image:PLExternalMultiWaterfallElement_Preview.png]] | ||
Line 61: | Line 67: | ||
=== Published === | === Published === | ||
*[[Property PLMultiWaterfall.TPLMultiWaterfall.Channels|Channels]] - Access the individual channels of the Multi Waterfall. | *[[Property PLMultiWaterfall.TPLMultiWaterfall.Channels|Channels]] - Access the individual channels of the Multi Waterfall. | ||
+ | *[[Property PLMultiWaterfall.TPLMultiWaterfall.Cursors|Cursors]] - Collection of measurement cursors. | ||
*[[Property PLMultiWaterfall.TPLMultiWaterfall.ChannelButtons|ChannelButtons]] - Specifies the appearance and the behavior of the channel buttons. | *[[Property PLMultiWaterfall.TPLMultiWaterfall.ChannelButtons|ChannelButtons]] - Specifies the appearance and the behavior of the channel buttons. | ||
Line 70: | Line 77: | ||
=== Public === | === Public === | ||
+ | *[[Method function PLMultiWaterfall.TPLMultiWaterfall.GetDataView() : TSLDisplayView|function GetDataView() : TSLDisplayView]] | ||
+ | *[[Method function PLMultiWaterfall.TPLMultiWaterfall.GetColorChannelIndex(TSLDisplayView) : Integer|function GetColorChannelIndex(AView : TSLDisplayView) : Integer]] | ||
*[[Method procedure PLMultiWaterfall.TPLMultiWaterfall.DoColorChannelClick(Integer)|procedure DoColorChannelClick(AItemIndex : Integer)]] | *[[Method procedure PLMultiWaterfall.TPLMultiWaterfall.DoColorChannelClick(Integer)|procedure DoColorChannelClick(AItemIndex : Integer)]] | ||
+ | *[[Method function PLMultiWaterfall.TPLMultiWaterfall.GetCursors() : TSLDisplayCursors|function GetCursors() : TSLDisplayCursors]] | ||
== PinLists == | == PinLists == | ||
Line 80: | Line 90: | ||
=== Published === | === Published === | ||
− | |||
*[[Property SLWaterfall.TSLBasicWaterfall.XAxis|XAxis]] | *[[Property SLWaterfall.TSLBasicWaterfall.XAxis|XAxis]] | ||
*[[Property SLWaterfall.TSLBasicWaterfall.YAxis|YAxis]] | *[[Property SLWaterfall.TSLBasicWaterfall.YAxis|YAxis]] | ||
*[[Property SLWaterfall.TSLBasicWaterfall.Legend|Legend]] | *[[Property SLWaterfall.TSLBasicWaterfall.Legend|Legend]] | ||
+ | *[[Property SLWaterfall.TSLBasicWaterfall.CursorLinks|CursorLinks]] | ||
*[[Property SLWaterfall.TSLBasicWaterfall.MarkerGroups|MarkerGroups]] | *[[Property SLWaterfall.TSLBasicWaterfall.MarkerGroups|MarkerGroups]] | ||
+ | *[[Property SLWaterfall.TSLBasicWaterfall.Labels|Labels]] | ||
*[[Property SLWaterfall.TSLBasicWaterfall.Highlighting|Highlighting]] | *[[Property SLWaterfall.TSLBasicWaterfall.Highlighting|Highlighting]] | ||
*[[Property SLWaterfall.TSLBasicWaterfall.Vertical|Vertical]] | *[[Property SLWaterfall.TSLBasicWaterfall.Vertical|Vertical]] | ||
Line 91: | Line 102: | ||
=== 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 102: | Line 116: | ||
=== Published === | === Published === | ||
*[[Property SLScope.TSLDataDisplay.Color|Color]] | *[[Property SLScope.TSLDataDisplay.Color|Color]] | ||
+ | *[[Property SLScope.TSLDataDisplay.Title|Title]] | ||
*[[Property SLScope.TSLDataDisplay.ToolBar|ToolBar]] | *[[Property SLScope.TSLDataDisplay.ToolBar|ToolBar]] | ||
*[[Property SLScope.TSLDataDisplay.Zooming|Zooming]] | *[[Property SLScope.TSLDataDisplay.Zooming|Zooming]] | ||
*[[Property SLScope.TSLDataDisplay.Cursor|Cursor]] | *[[Property SLScope.TSLDataDisplay.Cursor|Cursor]] | ||
*[[Property SLScope.TSLDataDisplay.NavigateMode|NavigateMode]] | *[[Property SLScope.TSLDataDisplay.NavigateMode|NavigateMode]] | ||
+ | *[[Property SLScope.TSLDataDisplay.Trails|Trails]] | ||
*[[Property SLScope.TSLDataDisplay.Elements|Elements]] | *[[Property SLScope.TSLDataDisplay.Elements|Elements]] | ||
*[[Property SLScope.TSLDataDisplay.RefreshInterval|RefreshInterval]] | *[[Property SLScope.TSLDataDisplay.RefreshInterval|RefreshInterval]] | ||
Line 120: | Line 136: | ||
*[[Property SLScope.TSLDataDisplay.PlotHeight|PlotHeight]] | *[[Property SLScope.TSLDataDisplay.PlotHeight|PlotHeight]] | ||
*[[Property SLScope.TSLDataDisplay.Views|Views]] | *[[Property SLScope.TSLDataDisplay.Views|Views]] | ||
− | |||
== Methods == | == Methods == | ||
Line 130: | Line 145: | ||
*[[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()]] | *[[Method procedure SLScope.TSLDataDisplay.InvalidateRefresh()|procedure InvalidateRefresh()]] | ||
*[[Method procedure SLScope.TSLDataDisplay.PostRefresh()|procedure PostRefresh()]] | *[[Method procedure SLScope.TSLDataDisplay.PostRefresh()|procedure PostRefresh()]] | ||
Line 136: | Line 152: | ||
*[[Method function SLScope.TSLDataDisplay.GetAxisValueAt(Integer;Integer;Real;Real) : Boolean|function GetAxisValueAt(X : Integer; Y : Integer; var AxisX : Real; var AxisY : Real) : Boolean]] | *[[Method function SLScope.TSLDataDisplay.GetAxisValueAt(Integer;Integer;Real;Real) : Boolean|function GetAxisValueAt(X : Integer; Y : Integer; var AxisX : Real; var AxisY : Real) : Boolean]] | ||
*[[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()]] | *[[Method procedure SLScope.TSLDataDisplay.Print()|procedure Print()]] | ||
*[[Method procedure SLScope.TSLDataDisplay.CopyToClipboard()|procedure CopyToClipboard()]] | *[[Method procedure SLScope.TSLDataDisplay.CopyToClipboard()|procedure CopyToClipboard()]] | ||
*[[Method procedure SLScope.TSLDataDisplay.SaveToBitmap(String)|procedure SaveToBitmap(FileName : String)]] | *[[Method procedure SLScope.TSLDataDisplay.SaveToBitmap(String)|procedure SaveToBitmap(FileName : String)]] | ||
*[[Method procedure SLScope.TSLDataDisplay.SaveToJpeg(String)|procedure SaveToJpeg(FileName : String)]] | *[[Method procedure SLScope.TSLDataDisplay.SaveToJpeg(String)|procedure SaveToJpeg(FileName : String)]] | ||
+ | *[[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 158: | Line 180: | ||
*[[Event SLScope.TSLDataDisplay.OnZoomChanged|OnZoomChanged]] | *[[Event SLScope.TSLDataDisplay.OnZoomChanged|OnZoomChanged]] | ||
*[[Event SLScope.TSLDataDisplay.OnDataToolTip|OnDataToolTip]] | *[[Event SLScope.TSLDataDisplay.OnDataToolTip|OnDataToolTip]] | ||
+ | *[[Event SLScope.TSLDataDisplay.OnPaint|OnPaint]] | ||
*[[Event SLScope.TSLDataDisplay.OnKeyDown|OnKeyDown]] | *[[Event SLScope.TSLDataDisplay.OnKeyDown|OnKeyDown]] | ||
*[[Event SLScope.TSLDataDisplay.OnKeyPress|OnKeyPress]] | *[[Event SLScope.TSLDataDisplay.OnKeyPress|OnKeyPress]] | ||
Line 166: | Line 189: | ||
*[[Event SLScope.TSLDataDisplay.OnMouseMove|OnMouseMove]] | *[[Event SLScope.TSLDataDisplay.OnMouseMove|OnMouseMove]] | ||
*[[Event SLScope.TSLDataDisplay.OnMouseUp|OnMouseUp]] | *[[Event SLScope.TSLDataDisplay.OnMouseUp|OnMouseUp]] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== From [[Class SLControlCollection.TSLCustomControlItem|TSLCustomControlItem]] == | == From [[Class SLControlCollection.TSLCustomControlItem|TSLCustomControlItem]] == | ||
Line 197: | Line 201: | ||
=== 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)]] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
[[Category:Elements]][[Category:Classes]] | [[Category:Elements]][[Category:Classes]] |
Latest revision as of 00:31, 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: PlotLabPkg
Unit: PLMultiWaterfall
Inherits: TPLMultiWaterfallLayer
Contents |
Syntax
Delphi:
type TPLExternalMultiWaterfallElement = class( TPLMultiWaterfallLayer, ILPComponentElement, ILPDrawComponentElement )
C++ Builder:
class TPLExternalMultiWaterfallElement : public TPLMultiWaterfallLayer
Visual C++ (MFC):
class CTPLExternalMultiWaterfallElement : public CTPLMultiWaterfallLayer
C# (.NET):
public ref class ExternalMultiWaterfallElement : Mitov.PlotLab.MultiWaterfallLayer
Summary
A scope component element.
Description
Add this component element to draw scope 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 TPLMultiWaterfall
Properties
Published
- Channels - Access the individual channels of the Multi Waterfall.
- Cursors - Collection of measurement cursors.
- ChannelButtons - Specifies the appearance and the behavior of the channel buttons.
Public
- ToolTipZValue - Returns the current ToolTip Z values for each channel by index.
- DataView - The data view area of the Multi Waterfall.
Methods
Public
- function GetDataView() : TSLDisplayView
- function GetColorChannelIndex(AView : TSLDisplayView) : Integer
- procedure DoColorChannelClick(AItemIndex : Integer)
- function GetCursors() : TSLDisplayCursors
PinLists
- InputPins - The input pins for the component.
From TSLBasicWaterfall
Properties
Published
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
Public
Methods
Public
- procedure SetToolTipText(AValue : PChar)
- function GetToolTipText() : String
- procedure SetBounds(ALeft : Integer; ATop : Integer; AWidth : Integer; AHeight : Integer)
- procedure Loaded()
- procedure SetParent(AParent : TWinControl)
- function GetOperations() : TLPDrawLayerOperations
- procedure InvalidateRefresh()
- procedure PostRefresh()
- procedure RefreshView()
- procedure CopyToBitmap(ABitmap : TBitmap)
- function GetAxisValueAt(X : Integer; Y : Integer; var AxisX : Real; var AxisY : Real) : Boolean
- procedure GetChildren(Proc : TGetChildProc; Root : TComponent)
- function GetHighlightInfo() : TSLHighlightInfo
- function GetHighlighting() : TSLDisplayHighlighting
- function GetCursors() : TSLDisplayCursors
- procedure Print()
- procedure CopyToClipboard()
- procedure SaveToBitmap(FileName : String)
- procedure SaveToJpeg(FileName : String)
- 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()
- 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)
- procedure ZoomTo(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)
- procedure ZoomToData(XMin : Real; XMax : Real; YMin : Real; YMax : Real)
- procedure ZoomToData(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)
- procedure UndoZoom()
- procedure RedoZoom()
- procedure ClearZoomUndo()
Events
- OnZoomChanged
- OnDataToolTip
- OnPaint
- OnKeyDown
- OnKeyPress
- OnKeyUp
- OnClick
- OnDblClick
- OnMouseDown
- OnMouseMove
- OnMouseUp