Class PLMultiWaterfall.TPLExternalMultiWaterfallMatrixLayer

Revision as of 20:30, 10 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit

Revision as of 00:07, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) Newer edit →

---

Revision as of 00:07, 11 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: TPLExternalMultiWaterfallElement

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 From TPLExternalMultiWaterfallElement 5 Properties 5.1 Published 6 Methods 6.1 Public 7 From TPLMultiWaterfall 8 Properties 8.1 Published 8.2 Public 9 Methods 9.1 Public 10 PinLists 11 From TSLBasicWaterfall 12 Properties 12.1 Published 13 Methods 13.1 Public 14 From TSLDataDisplay 15 Properties 15.1 Published 15.2 Public 16 Methods 16.1 Public 17 Events 18 From TSLCustomControlItem 19 Properties 19.1 Public 20 Methods 20.1 Public

Syntax

Delphi:

type TPLExternalMultiWaterfallMatrixLayer = class( TPLExternalMultiWaterfallElement, ILPMatrixComponentElement )

C++ Builder:

class TPLExternalMultiWaterfallMatrixLayer : public TPLExternalMultiWaterfallElement

Visual C++ (MFC):

class CTPLExternalMultiWaterfallMatrixLayer : public CTPLExternalMultiWaterfallElement

C# (.NET):

public ref class TPLExternalMultiWaterfallMatrixLayer : Mitov.PlotLab.ExternalMultiWaterfallElement

Summary

A waterfall matrix component layer.

Description

Add this matrix component layer to draw waterfall in a matrix.

Diagram:

Example:

From TPLExternalMultiWaterfallElement

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

• XAxis
• YAxis
• Legend
• CursorLinks
• MarkerGroups
• Labels
• Highlighting
• Vertical

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
• Title
• ToolBar
• Zooming
• Cursor
• NavigateMode
• Trails
• Elements
• RefreshInterval
• Visible
• TabStop

Public

• CanRedoZoom
• CanUndoZoom
• CanZoomOut
• CanZoomIn
• Hold
• PlotWidth
• PlotHeight
• Views

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

From TSLCustomControlItem

Properties

Public

• Index
• ComponentList

Methods

Public

• function GetParentComponent() : TComponent
• function HasParent() : Boolean
• procedure SetParent(AParent : TWinControl)
• function GetHasEnable() : Boolean
• function GetCanDisable() : Boolean
• procedure SetParentComponent(AValue : TComponent)