Class SLScope.TSLDisplayChannel

Revision as of 00:16, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit

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

---

Revision as of 02:45, 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: SignalLabScopePkg

Unit: SLScope

Inherits: TSLOptionalDisplayCollectionItem

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Properties 4.1 Published 4.2 Public 5 Methods 5.1 Public 6 From TSLOptionalDisplayCollectionItem 7 Properties 7.1 Published 8 From TSLDisplaySelectableCollectionItem 9 Methods 9.1 Public 10 From TSLDisplayCollectionItem 11 Properties 11.1 Published 12 From TLPNamedCollectionItem 13 Properties 13.1 Published 14 From TLPCollectionItem 15 Methods 15.1 Public

Syntax

Delphi:

type TSLDisplayChannel = class( TSLOptionalDisplayCollectionItem )

C++ Builder:

class TSLDisplayChannel : public TSLOptionalDisplayCollectionItem

Visual C++ (MFC):

class CTSLDisplayChannel : public CTSLOptionalDisplayCollectionItem

C# (.NET):

public ref class TSLDisplayChannel : Mitov.PlotLab.OptionalDisplayCollectionItem

Summary

Base abstract class for visual data displays channels.

Description

This is a base class for visual data displays channels such as the channels in Scopes and Spectrum Analyzers. Do not make instances of this class.

Properties

Published

• XAxisIndex - Specifies the index of the X axis the channel will be associated with.
• YAxisIndex - Specifies the index of the Y axis the channel will be associated with.
• Color - Specifies the color for the plotting of the channel data.
• Width - Specifies the width in pixels for the plotting of the channel data.
• Points - Specifies the look and feel of the channel points.
• ChannelMode - Specifies the channel display mode as line, bars or points.
• MouseCursor - Specifies the image used to represent the mouse pointer when it passes into the region covered by the chanel.
• Style - Specifies the pen style of the channel.

Public

• XAxis - Specifies the X axis the channel will be associated with.
• YAxis - Specifies the Y axis the channel will be associated with.

Methods

Public

• function GetXPointsAtValue(YValue : Real) : TSLScopeRealPoints
• function GetYPointsAtValue(XValue : Real) : TSLScopeRealPoints
• function GetOwnerComponent() : TSLDataDisplay
• procedure Invalidate()
• procedure InvalidateChannel()

From TSLOptionalDisplayCollectionItem

Properties

Published

• Visible - Specifies if the item will be visible.

From TSLDisplaySelectableCollectionItem

Methods

Public

• procedure MouseEnter()
• procedure MouseLeave()
• procedure MouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean; var MouseHandled : Boolean)
• procedure MouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean)

From TSLDisplayCollectionItem

Properties

Published

• Tag - Stores an general purpose integer value as part of an item

From TLPNamedCollectionItem

Properties

Published

• Name

From TLPCollectionItem

Methods

Public

• function QueryInterface(IID : TGUID; Obj : TLPCollectionItem) : HResult