Class PLMultiWaterfall.TPLMultiWaterfall

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

Syntax

Delphi:

type TPLMultiWaterfall = class( TSLBasicWaterfall )

C++ Builder:

class TPLMultiWaterfall : public TSLBasicWaterfall

Visual C++ (MFC):

class CTPLMultiWaterfall : public CTSLBasicWaterfall

C# (.NET):

public ref class TPLMultiWaterfall : Mitov.PlotLab.BasicWaterfall

Summary

Visible multi-channel waterfall for representing Real(double) data.

Description

Use this component to visualize floating point data as waterfall.

Diagram:

Example:

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!

  CTPLMultiWaterfall PLWaterfall;
  PLWaterfall.Open( m_WaterfallDisplay.m_hWnd );

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)