Class SLScope.TSLScopeYAxis
From Mitov Wiki Doc
(Difference between revisions)
(Automated Syncronization with Documentation) |
(Automated Syncronization with Documentation) |
||
Line 62: | Line 62: | ||
*[[Method procedure SLScope.TSLBasicScopeYAxis.Draw(TSLDisplayDrawPart;TLPCanvas;Boolean;Boolean)|procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)]] | *[[Method procedure SLScope.TSLBasicScopeYAxis.Draw(TSLDisplayDrawPart;TLPCanvas;Boolean;Boolean)|procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)]] | ||
*[[Method procedure SLScope.TSLBasicScopeYAxis.DrawEx(TSLDisplayDrawPart;TLPCanvas;Boolean)|procedure DrawEx(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean)]] | *[[Method procedure SLScope.TSLBasicScopeYAxis.DrawEx(TSLDisplayDrawPart;TLPCanvas;Boolean)|procedure DrawEx(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean)]] | ||
+ | *[[Method function SLScope.TSLBasicScopeYAxis.GetAxisLabelText() : String|function GetAxisLabelText() : String]] | ||
+ | *[[Method function SLScope.TSLBasicScopeYAxis.GetDataZoomedMin() : Real|function GetDataZoomedMin() : Real]] | ||
+ | *[[Method function SLScope.TSLBasicScopeYAxis.GetDataZoomedMax() : Real|function GetDataZoomedMax() : Real]] | ||
*[[Method procedure SLScope.TSLBasicScopeYAxis.InvalidateStep()|procedure InvalidateStep()]] | *[[Method procedure SLScope.TSLBasicScopeYAxis.InvalidateStep()|procedure InvalidateStep()]] | ||
Line 70: | Line 73: | ||
=== Published === | === Published === | ||
*[[Property SLScope.TSLDisplayYAxis.ScaleMode|ScaleMode]] - Specifies the scale mode - logarithmic or linear. | *[[Property SLScope.TSLDisplayYAxis.ScaleMode|ScaleMode]] - Specifies the scale mode - logarithmic or linear. | ||
+ | |||
+ | == From [[Class SLScope.TSLBasicDisplayYAxis|TSLBasicDisplayYAxis]] == | ||
+ | |||
+ | == Properties == | ||
+ | |||
+ | === Published === | ||
+ | *[[Property SLScope.TSLBasicDisplayYAxis.Align|Align]] | ||
== From [[Class SLScope.TSLDisplayAxis|TSLDisplayAxis]] == | == From [[Class SLScope.TSLDisplayAxis|TSLDisplayAxis]] == | ||
Line 102: | Line 112: | ||
*[[Method procedure SLScope.TSLDisplayAxis.ZoomToData(Real;Real;Boolean)|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. | *[[Method procedure SLScope.TSLDisplayAxis.ZoomToData(Real;Real;Boolean)|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. | ||
*[[Method procedure SLScope.TSLDisplayAxis.SetTickText(PChar)|procedure SetTickText(AValue : PChar)]] - Provides a new TickText value( Visual C++ (MFC/Win32) only ). | *[[Method procedure SLScope.TSLDisplayAxis.SetTickText(PChar)|procedure SetTickText(AValue : PChar)]] - Provides a new TickText value( Visual C++ (MFC/Win32) only ). | ||
+ | *[[Method function SLScope.TSLDisplayAxis.GetAxisLabelText() : String|function GetAxisLabelText() : String]] | ||
*[[Method function SLScope.TSLDisplayAxis.GetValueAt(Integer;Integer;Real) : Boolean|function GetValueAt(X : Integer; Y : Integer; var AxisPos : Real) : Boolean]] - Returns the axis value at X, Y position. | *[[Method function SLScope.TSLDisplayAxis.GetValueAt(Integer;Integer;Real) : Boolean|function GetValueAt(X : Integer; Y : Integer; var AxisPos : Real) : Boolean]] - Returns the axis value at X, Y position. | ||
*[[Method function SLScope.TSLDisplayAxis.ScaleToPixel(Real) : Integer|function ScaleToPixel(AValue : Real) : Integer]] - Converts a scale value to pixel position. | *[[Method function SLScope.TSLDisplayAxis.ScaleToPixel(Real) : Integer|function ScaleToPixel(AValue : Real) : Integer]] - Converts a scale value to pixel position. | ||
Line 108: | Line 119: | ||
*[[Method procedure SLScope.TSLDisplayAxis.Draw(TSLDisplayDrawPart;TLPCanvas;Boolean;Boolean)|procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)]] | *[[Method procedure SLScope.TSLDisplayAxis.Draw(TSLDisplayDrawPart;TLPCanvas;Boolean;Boolean)|procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)]] | ||
*[[Method procedure SLScope.TSLDisplayAxis.ButtonHitTest(Integer;Integer;Boolean)|procedure ButtonHitTest(X : Integer; Y : Integer; AForceInvalidate : Boolean)]] | *[[Method procedure SLScope.TSLDisplayAxis.ButtonHitTest(Integer;Integer;Boolean)|procedure ButtonHitTest(X : Integer; Y : Integer; AForceInvalidate : Boolean)]] | ||
+ | *[[Method function SLScope.TSLDisplayAxis.GetOwner() : TPersistent|function GetOwner() : TPersistent]] | ||
== Pins == | == Pins == | ||
Line 134: | Line 146: | ||
=== Published === | === Published === | ||
*[[Property SLScope.TSLOptionalView.Visible|Visible]] - Specifies whether or not the viw is visible. | *[[Property SLScope.TSLOptionalView.Visible|Visible]] - Specifies whether or not the viw is visible. | ||
+ | |||
+ | == Methods == | ||
+ | |||
+ | === Public === | ||
+ | *[[Method function SLScope.TSLOptionalView.IsVisible() : Boolean|function IsVisible() : Boolean]] | ||
+ | *[[Method function SLScope.TSLOptionalView.IsVisibleForced() : Boolean|function IsVisibleForced() : Boolean]] | ||
== From [[Class SLScope.TSLCustomSizeDisplayView|TSLCustomSizeDisplayView]] == | == From [[Class SLScope.TSLCustomSizeDisplayView|TSLCustomSizeDisplayView]] == | ||
Line 164: | Line 182: | ||
=== Public === | === Public === | ||
+ | *[[Method function SLScope.TSLDisplayView.IsVisible() : Boolean|function IsVisible() : Boolean]] | ||
+ | *[[Method function SLScope.TSLDisplayView.IsVisibleForced() : Boolean|function IsVisibleForced() : Boolean]] | ||
+ | *[[Method function SLScope.TSLDisplayView.GetIntValueAt(Integer;Integer) : Real|function GetIntValueAt(X : Integer; Y : Integer) : Real]] | ||
+ | *[[Method function SLScope.TSLDisplayView.GetMinValue() : Real|function GetMinValue() : Real]] | ||
+ | *[[Method function SLScope.TSLDisplayView.GetMaxValue() : Real|function GetMaxValue() : Real]] | ||
*[[Method procedure SLScope.TSLDisplayView.Draw(TSLDisplayDrawPart;TLPCanvas;Boolean;Boolean)|procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)]] | *[[Method procedure SLScope.TSLDisplayView.Draw(TSLDisplayDrawPart;TLPCanvas;Boolean;Boolean)|procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)]] | ||
*[[Method procedure SLScope.TSLDisplayView.DrawEx(TSLDisplayDrawPart;TLPCanvas;Boolean)|procedure DrawEx(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean)]] | *[[Method procedure SLScope.TSLDisplayView.DrawEx(TSLDisplayDrawPart;TLPCanvas;Boolean)|procedure DrawEx(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean)]] | ||
Line 174: | Line 197: | ||
=== Public === | === Public === | ||
*[[Property SLScope.TSLDisplayComponent.DrawRect|DrawRect]] | *[[Property SLScope.TSLDisplayComponent.DrawRect|DrawRect]] | ||
+ | |||
+ | == Methods == | ||
+ | |||
+ | === Public === | ||
+ | *[[Method function SLScope.TSLDisplayComponent.IsVisible() : Boolean|function IsVisible() : Boolean]] | ||
+ | *[[Method function SLScope.TSLDisplayComponent.GetOwner() : TPersistent|function GetOwner() : TPersistent]] | ||
== From [[Class LPComponent.TLPPersistent|TLPPersistent]] == | == From [[Class LPComponent.TLPPersistent|TLPPersistent]] == | ||
Line 180: | Line 209: | ||
=== Public === | === Public === | ||
+ | *[[Method function LPComponent.TLPPersistent.QueryInterface(TGUID;TObject) : HResult|function QueryInterface(IID : TGUID; Obj : TObject) : HResult]] | ||
+ | *[[Method function LPComponent.TLPPersistent.GetOwner() : TPersistent|function GetOwner() : TPersistent]] | ||
*[[Method procedure LPComponent.TLPPersistent.OwnerNameChanged(String;String)|procedure OwnerNameChanged(AOldName : String; ANewName : String)]] | *[[Method procedure LPComponent.TLPPersistent.OwnerNameChanged(String;String)|procedure OwnerNameChanged(AOldName : String; ANewName : String)]] | ||
[[Category:Classes]] | [[Category:Classes]] |
Revision as of 20:29, 10 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: TSLBasicScopeYAxis
Syntax
Delphi:
type TSLScopeYAxis = class( TSLBasicScopeYAxis )
C++ Builder:
class TSLScopeYAxis : public TSLBasicScopeYAxis
Visual C++ (MFC):
class CTSLScopeYAxis : public CTSLBasicScopeYAxis
C# (.NET):
public ref class TSLScopeYAxis : Mitov.PlotLab.BasicScopeYAxis
Summary
Scope X Axis class.
Description
Defines visual Y axis for a Scope. The Axes are created internally by the data displays. Do not make instances of this class or its descendants.
Example:
Properties
Published
- AdditionalAxes - Collection of additional Axes.
From TSLBasicScopeYAxis
Properties
Published
- AutoScaling - Specifies how the axis will auto scale.
- Reversed - Specifies reversed Axis.
- CursorSettings - Specifies the behavior of the cursors for the axis.
- DataView - Specifies the way the axis lines will be drawn in the data view.
Methods
Public
- procedure Draw(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean; Printing : Boolean)
- procedure DrawEx(ADrawPart : TSLDisplayDrawPart; ACanvas : TLPCanvas; Vertical : Boolean)
- function GetAxisLabelText() : String
- function GetDataZoomedMin() : Real
- function GetDataZoomedMax() : Real
- procedure InvalidateStep()
From TSLDisplayYAxis
Properties
Published
- ScaleMode - Specifies the scale mode - logarithmic or linear.
From TSLBasicDisplayYAxis
Properties
Published
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
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)