Class SLScope.TSLScopeChannel
From Mitov Wiki Doc
(Difference between revisions)
(Automated Syncronization with Documentation) |
(Automated Syncronization with Documentation) |
||
| (6 intermediate revisions by one user not shown) | |||
| Line 26: | Line 26: | ||
=== C# (.NET): === | === C# (.NET): === | ||
<code> | <code> | ||
| − | '''public ref class''' | + | '''public ref class''' ScopeChannel : [[Class SLScope.TSLDisplayChannel|Mitov.PlotLab.DisplayChannel]] |
</code> | </code> | ||
== Summary == | == Summary == | ||
| Line 46: | Line 46: | ||
=== Published === | === Published === | ||
*[[Property SLScope.TSLScopeChannel.ShadeMode|ShadeMode]] - Specifies the Shade mode for the channel. | *[[Property SLScope.TSLScopeChannel.ShadeMode|ShadeMode]] - Specifies the Shade mode for the channel. | ||
| + | *[[Property SLScope.TSLScopeChannel.Synchronize|Synchronize]] - Specifies if the channel data will be synchronized with the other channels. | ||
*[[Property SLScope.TSLScopeChannel.Markers|Markers]] - Collection of Markers associated with the Scope channel. | *[[Property SLScope.TSLScopeChannel.Markers|Markers]] - Collection of Markers associated with the Scope channel. | ||
| Line 56: | Line 57: | ||
=== Public === | === Public === | ||
*[[Method procedure SLScope.TSLScopeChannel.InvalidateChannel()|procedure InvalidateChannel()]] | *[[Method procedure SLScope.TSLScopeChannel.InvalidateChannel()|procedure InvalidateChannel()]] | ||
| + | *[[Method function SLScope.TSLScopeChannel.GetOwner() : TPersistent|function GetOwner() : TPersistent]] | ||
== Pins == | == Pins == | ||
| Line 77: | Line 79: | ||
*[[Property SLScope.TSLDisplayChannel.ChannelMode|ChannelMode]] - Specifies the channel display mode as line, bars or points. | *[[Property SLScope.TSLDisplayChannel.ChannelMode|ChannelMode]] - Specifies the channel display mode as line, bars or points. | ||
*[[Property SLScope.TSLDisplayChannel.MouseCursor|MouseCursor]] - Specifies the image used to represent the mouse pointer when it passes into the region covered by the chanel. | *[[Property SLScope.TSLDisplayChannel.MouseCursor|MouseCursor]] - Specifies the image used to represent the mouse pointer when it passes into the region covered by the chanel. | ||
| + | *[[Property SLScope.TSLDisplayChannel.Style|Style]] - Specifies the pen style of the channel. | ||
=== Public === | === Public === | ||
| Line 85: | Line 88: | ||
=== Public === | === Public === | ||
| + | *[[Method function SLScope.TSLDisplayChannel.GetXPointsAtValue(Real) : TSLScopeRealPoints|function GetXPointsAtValue(YValue : Real) : TSLScopeRealPoints]] | ||
| + | *[[Method function SLScope.TSLDisplayChannel.GetYPointsAtValue(Real) : TSLScopeRealPoints|function GetYPointsAtValue(XValue : Real) : TSLScopeRealPoints]] | ||
| + | *[[Method function SLScope.TSLDisplayChannel.GetOwnerComponent() : TSLDataDisplay|function GetOwnerComponent() : TSLDataDisplay]] | ||
*[[Method procedure SLScope.TSLDisplayChannel.Invalidate()|procedure Invalidate()]] | *[[Method procedure SLScope.TSLDisplayChannel.Invalidate()|procedure Invalidate()]] | ||
*[[Method procedure SLScope.TSLDisplayChannel.InvalidateChannel()|procedure InvalidateChannel()]] | *[[Method procedure SLScope.TSLDisplayChannel.InvalidateChannel()|procedure InvalidateChannel()]] | ||
| Line 94: | Line 100: | ||
=== Published === | === Published === | ||
*[[Property SLScope.TSLOptionalDisplayCollectionItem.Visible|Visible]] - Specifies if the item will be visible. | *[[Property SLScope.TSLOptionalDisplayCollectionItem.Visible|Visible]] - Specifies if the item will be visible. | ||
| + | |||
| + | == From [[Class SLScope.TSLDisplaySelectableCollectionItem|TSLDisplaySelectableCollectionItem]] == | ||
| + | |||
| + | == Methods == | ||
| + | |||
| + | === Public === | ||
| + | *[[Method procedure SLScope.TSLDisplaySelectableCollectionItem.MouseEnter()|procedure MouseEnter()]] | ||
| + | *[[Method procedure SLScope.TSLDisplaySelectableCollectionItem.MouseLeave()|procedure MouseLeave()]] | ||
| + | *[[Method procedure SLScope.TSLDisplaySelectableCollectionItem.MouseDown(TMouseButton;TShiftState;Integer;Integer;Boolean;Boolean)|procedure MouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean; var MouseHandled : Boolean)]] | ||
| + | *[[Method procedure SLScope.TSLDisplaySelectableCollectionItem.MouseUp(TMouseButton;TShiftState;Integer;Integer;Boolean)|procedure MouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean)]] | ||
== From [[Class SLScope.TSLDisplayCollectionItem|TSLDisplayCollectionItem]] == | == From [[Class SLScope.TSLDisplayCollectionItem|TSLDisplayCollectionItem]] == | ||
| Line 100: | Line 116: | ||
=== Published === | === Published === | ||
| − | |||
*[[Property SLScope.TSLDisplayCollectionItem.Tag|Tag]] - Stores an general purpose integer value as part of an item | *[[Property SLScope.TSLDisplayCollectionItem.Tag|Tag]] - Stores an general purpose integer value as part of an item | ||
| + | |||
| + | == From [[Class LPComponent.TLPNamedCollectionItem|TLPNamedCollectionItem]] == | ||
| + | |||
| + | == Properties == | ||
| + | |||
| + | === Published === | ||
| + | *[[Property LPComponent.TLPNamedCollectionItem.Name|Name]] | ||
| + | |||
| + | == From [[Class LPComponent.TLPCollectionItem|TLPCollectionItem]] == | ||
| + | |||
| + | == Methods == | ||
| + | |||
| + | === Public === | ||
| + | *[[Method function LPComponent.TLPCollectionItem.QueryInterface(TGUID;TLPCollectionItem) : HResult|function QueryInterface(IID : TGUID; Obj : TLPCollectionItem) : HResult]] | ||
[[Category:Classes]] | [[Category:Classes]] | ||
Latest revision as of 00:30, 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: SLScope
Inherits: TSLDisplayChannel
Syntax
Delphi:
type TSLScopeChannel = class( TSLDisplayChannel )
C++ Builder:
class TSLScopeChannel : public TSLDisplayChannel
Visual C++ (MFC):
class CTSLScopeChannel : public CTSLDisplayChannel
C# (.NET):
public ref class ScopeChannel : Mitov.PlotLab.DisplayChannel
Summary
Visual Scope data channels class.
Description
Defines the class for visual data display channels such as the channels in Scope components. Do not make instances of this class.
Example of 3 channels in a data view:
Properties
Published
- ShadeMode - Specifies the Shade mode for the channel.
- Synchronize - Specifies if the channel data will be synchronized with the other channels.
- Markers - Collection of Markers associated with the Scope channel.
Public
- DrawMarkers - Collection of currently drawn Markers associated with the Scope channel.
- Data - Allows setting the channel data.
Methods
Public
Pins
Events
- OnSampleDraw - Occurs when a sample is in about to be painted.
- OnChannelDraw - Occurs when a channel is in about to be painted.
From TSLDisplayChannel
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
