Class SLScope.TSLBasicScopeXAxis

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

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 5 Methods 5.1 Public 6 From TSLDisplayXAxis 7 Properties 7.1 Published 8 From TSLBasicDisplayXAxis 9 Properties 9.1 Published 9.2 Public 10 Methods 10.1 Public 11 From TSLDisplayAxis 12 Properties 12.1 Published 12.2 Public 13 Methods 13.1 Public 14 Pins 15 Events 16 From TSLTrackingOptionalAxis 17 Properties 17.1 Published 18 Events 19 From TSLOptionalView 20 Properties 20.1 Published 21 Methods 21.1 Public 22 From TSLCustomSizeDisplayView 23 Properties 23.1 Published 24 From TSLCustomColorDisplayView 25 Properties 25.1 Published 26 From TSLDisplayView 27 Properties 27.1 Public 28 Methods 28.1 Public 29 From TSLDisplayComponent 30 Properties 30.1 Public 31 Methods 31.1 Public 32 From TLPPersistent 33 Methods 33.1 Public

Syntax

Delphi:

type TSLBasicScopeXAxis = class( TSLDisplayXAxis )

C++ Builder:

class TSLBasicScopeXAxis : public TSLDisplayXAxis

Visual C++ (MFC):

class CTSLBasicScopeXAxis : public CTSLDisplayXAxis

C# (.NET):

public ref class TSLBasicScopeXAxis : Mitov.PlotLab.DisplayXAxis

Summary

Scope X Axis abstract base class.

Description

Defines visual X axis for the Scope components. The Axes are created internally by the data displays. Do not make instances of this class or its descendants.

Example:

Properties

Published

• TicksMode - Specifies how the values for the ticks will be calculated.
• CursorSettings - Specifies the behavior of the cursors for the axis.
• UnitScale - Specifies the way the units scaling will be done - Hz, KHz, MHz etc.
• MaxSample - Specifies the way the Max sample of the axis will be calculated.
• DataView - Specifies the way the axis lines will be drawn in the data view.

Methods

Public

• function ScaleToSample(AValue : Real) : Real - Converts from axis scale to sample value.
• procedure IntZoom(AValue : Real; Operation : TSLZoomOperation)
• function GetAxisLabelText() : String

From TSLDisplayXAxis

Properties

Published

• ScaleMode - Specifies the scale mode - logarithmic or linear.

From TSLBasicDisplayXAxis

Properties

Published

• Align

Public

• Samples - Count of samples shown for each channel.

Methods

Public

• procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)
• procedure DrawEx(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean)
• function GetAxisLabelText() : String

From TSLDisplayAxis

Properties

Published

• Format - Specifies the format of the axis labels.
• Color - Specifies the color for the axis ticks.
• Font - Specifies the font for the axis values.
• ToolBar - Specifies the behavior of the axis toolbar.
• Button - Specifies the appearance and the behavior of the Axis button.
• Min - Specifies the Minimal value shown on the axis if the AutoScale is not set to true.
• Max - Specifies the Maximal value shown on the axis if the AutoScale is not set to true.
• Zooming - Specifies the behavior of the axis zooming.
• AxisLabel - Specifies the appearance of the axis label.

Public

• CurrentMax - Current Max value in the axis.
• CurrentMin - Current Min value in the axis.
• AssociatedChannels - List of channels associated with the axis.
• Step - Current Ticks Step value of the axis.

Methods

Public

• procedure ZoomBy(AValue : Real) - Zooms by Value.
• procedure ZoomBy(AValue : Real; SaveHistory : Boolean) - Zooms by Value. Allows optionally the zoom history to be saved for Undo.
• procedure ZoomTo(AMin : Real; AMax : Real) - Zooms to show the range between YMin and YMax.
• procedure ZoomTo(AMin : Real; AMax : Real; SaveHistory : Boolean) - Zooms to show the range between YMin and YMax. Allows optionally the zoom history to be saved for Undo.
• procedure ZoomToData(AMin : Real; AMax : Real) - Zooms to show the range between YMin and YMax based on the data scaling.
• procedure ZoomToData(AMin : Real; AMax : Real; SaveHistory : Boolean) - Zooms to show the range between YMin and YMax based on the data scaling. Allows optionally the zoom history to be saved for Undo.
• procedure SetTickText(AValue : PChar) - Provides a new TickText value( Visual C++ (MFC/Win32) only ).
• function GetAxisLabelText() : String
• function GetValueAt(X : Integer; Y : Integer; var AxisPos : Real) : Boolean - Returns the axis value at X, Y position.
• function ScaleToPixel(AValue : Real) : Integer - Converts a scale value to pixel position.
• function PixelToScale(APosition : Integer) : Real - Converts a pixel position to scale value.
• procedure IntZoom(AValue : Real; Operation : TSLZoomOperation)
• procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)
• procedure ButtonHitTest(X : Integer; Y : Integer; AForceInvalidate : Boolean)
• function GetOwner() : TPersistent

Pins

• ZoomPin - Axis zooming state pin.

Events

• OnCustomLabel - Occurs when a label is in about to be painted.

From TSLTrackingOptionalAxis

Properties

Published

• TrackCursor - Enables/Disables the track hair in the axis.
• TrackColor - Specifies the color of the track hair in the axis.
• MinorTicks - Specifies the visual appearance of minor ticks in the axis scale.
• MajorTicks - Specifies the visual appearance of major ticks in the axis scale.

Events

• OnCustomStep - Occurs when a step(distance) is needed for plotting the next tick of the axis grid.

From TSLOptionalView

Properties

Published

• Visible - Specifies whether or not the viw is visible.

Methods

Public

• function IsVisible() : Boolean
• function IsVisibleForced() : Boolean

From TSLCustomSizeDisplayView

Properties

Published

• ViewSize - Specifies the way the view size will be calculated.
• Align - Specifies the desired alignment for the view (Left, Right, Top, Bottom etc.)

From TSLCustomColorDisplayView

Properties

Published

• Background - Specifies the background settings.

From TSLDisplayView

Properties

Public

• Height - Use this property to get the Height of the view in pixels.
• Width - Use this property to get the Width of the view in pixels.
• Top - Use this property to get the Top position of the view in pixels.
• Left - Use this property to get the Left position of the view in pixels.
• DefaultRect

Methods

Public

• function IsVisible() : Boolean
• function IsVisibleForced() : Boolean
• function GetIntValueAt(X : Integer; Y : Integer) : Real
• function GetMinValue() : Real
• function GetMaxValue() : Real
• procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)
• procedure DrawEx(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean)
• procedure DrawMouseSelction(ACanvas : TLPCanvas)

From TSLDisplayComponent

Properties

Public

• DrawRect

Methods

Public

• function IsVisible() : Boolean
• function GetOwner() : TPersistent

From TLPPersistent

Methods

Public

• function QueryInterface(IID : TGUID; Obj : TObject) : HResult
• function GetOwner() : TPersistent
• procedure OwnerNameChanged(AOldName : String; ANewName : String)