Class SLScope.TSLDisplayAxis - Revision history

David Alm: Automated Syncronization with Documentation

2013-06-26T00:30:29Z

Automated Syncronization with Documentation

← Older revision		Revision as of 00:30, 26 June 2013
Line 26:		Line 26:
	=== C# (.NET): ===		=== C# (.NET): ===
	<code>		<code>
−	'''public ref class''' ~~TSLDisplayAxis~~ : [[Class SLScope.TSLTrackingOptionalAxis\|Mitov.PlotLab.TrackingOptionalAxis]]	+	'''public ref class''' DisplayAxis : [[Class SLScope.TSLTrackingOptionalAxis\|Mitov.PlotLab.TrackingOptionalAxis]]
	</code>		</code>
	== Summary ==		== Summary ==

David Alm: Automated Syncronization with Documentation

2013-06-26T00:11:11Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:11, 26 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-25T23:53:03Z

Automated Syncronization with Documentation

← Older revision

Revision as of 23:53, 25 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T02:45:00Z

Automated Syncronization with Documentation

← Older revision

Revision as of 02:45, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:16:38Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:16, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:06:26Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:06, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-10T20:29:02Z

Automated Syncronization with Documentation

← Older revision		Revision as of 20:29, 10 June 2013
Line 66:		Line 66:
	*[[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 72:		Line 73:
	*[[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 98:		Line 100:
	=== 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 128:		Line 136:

	=== 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 138:		Line 151:
	=== 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 144:		Line 163:

	=== 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]]

David Alm: Automated Syncronization with Documentation

2011-11-22T00:20:32Z

Automated Syncronization with Documentation

New page

<b><span style="color:red">
This is a Beta Read Only version of this page.
Please review and send recommendations to [mailto:mitov@mitov.com mitov@mitov.com].
We will enable the editing as soon as we are happy with the overall Wiki site.
</span></b>

'''Package:''' [[Package SignalLabScopePkg|SignalLabScopePkg]]

'''Unit:''' [[Unit SLScope|SLScope]]

'''Inherits:''' [[Class SLScope.TSLTrackingOptionalAxis|TSLTrackingOptionalAxis]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' TSLDisplayAxis = '''class'''( [[Class SLScope.TSLTrackingOptionalAxis|TSLTrackingOptionalAxis]] )
</code>
=== C++ Builder: ===
<code>
'''class''' TSLDisplayAxis : '''public''' [[Class SLScope.TSLTrackingOptionalAxis|TSLTrackingOptionalAxis]]
</code>
=== Visual C++ (MFC): ===
<code>
'''class''' CTSLDisplayAxis : '''public''' [[Class SLScope.TSLTrackingOptionalAxis|CTSLTrackingOptionalAxis]]
</code>
=== C# (.NET): ===
<code>
'''public ref class''' TSLDisplayAxis : [[Class SLScope.TSLTrackingOptionalAxis|Mitov.PlotLab.TrackingOptionalAxis]]
</code>
== Summary ==
Basic abstract class for visual data axis.

== Description ==
This is a base class for data view for visual data axis such
as the X or Y axis in Scopes or Spectrum Analyzers. The Axes
are created internally by the data displays. Do not make
instances of this class or its descendants.

== Properties ==

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

=== Public ===
*[[Property SLScope.TSLDisplayAxis.CurrentMax|CurrentMax]] - Current [[Property SLScope.TSLDisplayAxis.Max|Max]] value in the axis.
*[[Property SLScope.TSLDisplayAxis.CurrentMin|CurrentMin]] - Current [[Property SLScope.TSLDisplayAxis.Min|Min]] value in the axis.
*[[Property SLScope.TSLDisplayAxis.AssociatedChannels|AssociatedChannels]] - List of channels associated with the axis.
*[[Property SLScope.TSLDisplayAxis.Step|Step]] - Current Ticks Step value of the axis.

== Methods ==

=== Public ===
*[[Method procedure SLScope.TSLDisplayAxis.ZoomBy(Real)|procedure ZoomBy(AValue : Real)]] - Zooms by Value.
*[[Method procedure SLScope.TSLDisplayAxis.ZoomBy(Real;Boolean)|procedure ZoomBy(AValue : Real; SaveHistory : Boolean)]] - Zooms by Value. Allows optionally the zoom history to be saved for Undo.
*[[Method procedure SLScope.TSLDisplayAxis.ZoomTo(Real;Real)|procedure ZoomTo(AMin : Real; AMax : Real)]] - Zooms to show the range between YMin and YMax.
*[[Method procedure SLScope.TSLDisplayAxis.ZoomTo(Real;Real;Boolean)|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.
*[[Method procedure SLScope.TSLDisplayAxis.ZoomToData(Real;Real)|procedure ZoomToData(AMin : Real; AMax : Real)]] - Zooms to show the range between YMin and YMax based on the data scaling.
*[[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 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.PixelToScale(Integer) : Real|function PixelToScale(APosition : Integer) : Real]] - Converts a pixel position to scale value.
*[[Method procedure SLScope.TSLDisplayAxis.IntZoom(Real;TSLZoomOperation)|procedure IntZoom(AValue : Real; Operation : TSLZoomOperation)]]
*[[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)]]

== Pins ==
*[[Pin SLScope.TSLDisplayAxis.ZoomPin|ZoomPin]] - Axis zooming state pin.

== Events ==
*[[Event SLScope.TSLDisplayAxis.OnCustomLabel|OnCustomLabel]] - Occurs when a label is in about to be painted.

== From [[Class SLScope.TSLTrackingOptionalAxis|TSLTrackingOptionalAxis]] ==

== Properties ==

=== Published ===
*[[Property SLScope.TSLTrackingOptionalAxis.TrackCursor|TrackCursor]] - Enables/Disables the track hair in the axis.
*[[Property SLScope.TSLTrackingOptionalAxis.TrackColor|TrackColor]] - Specifies the color of the track hair in the axis.
*[[Property SLScope.TSLTrackingOptionalAxis.MinorTicks|MinorTicks]] - Specifies the visual appearance of minor ticks in the axis scale.
*[[Property SLScope.TSLTrackingOptionalAxis.MajorTicks|MajorTicks]] - Specifies the visual appearance of major ticks in the axis scale.

== Events ==
*[[Event SLScope.TSLTrackingOptionalAxis.OnCustomStep|OnCustomStep]] - Occurs when a step(distance) is needed for plotting the next tick of the axis grid.

== From [[Class SLScope.TSLOptionalView|TSLOptionalView]] ==

== Properties ==

=== Published ===
*[[Property SLScope.TSLOptionalView.Visible|Visible]] - Specifies whether or not the viw is visible.

== From [[Class SLScope.TSLCustomSizeDisplayView|TSLCustomSizeDisplayView]] ==

== Properties ==

=== Published ===
*[[Property SLScope.TSLCustomSizeDisplayView.ViewSize|ViewSize]] - Specifies the way the view size will be calculated.
*[[Property SLScope.TSLCustomSizeDisplayView.Align|Align]] - Specifies the desired alignment for the view (Left, Right, Top, Bottom etc.)

== From [[Class SLScope.TSLCustomColorDisplayView|TSLCustomColorDisplayView]] ==

== Properties ==

=== Published ===
*[[Property SLScope.TSLCustomColorDisplayView.Background|Background]] - Specifies the background settings.

== From [[Class SLScope.TSLDisplayView|TSLDisplayView]] ==

== Properties ==

=== Public ===
*[[Property SLScope.TSLDisplayView.Height|Height]] - Use this property to get the Height of the view in pixels.
*[[Property SLScope.TSLDisplayView.Width|Width]] - Use this property to get the Width of the view in pixels.
*[[Property SLScope.TSLDisplayView.Top|Top]] - Use this property to get the Top position of the view in pixels.
*[[Property SLScope.TSLDisplayView.Left|Left]] - Use this property to get the Left position of the view in pixels.
*[[Property SLScope.TSLDisplayView.DefaultRect|DefaultRect]]

== Methods ==

=== Public ===
*[[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.DrawMouseSelction(TLPCanvas)|procedure DrawMouseSelction(ACanvas : TLPCanvas)]]

== From [[Class SLScope.TSLDisplayComponent|TSLDisplayComponent]] ==

== Properties ==

=== Public ===
*[[Property SLScope.TSLDisplayComponent.DrawRect|DrawRect]]

== From [[Class LPComponent.TLPPersistent|TLPPersistent]] ==

== Methods ==

=== Public ===
*[[Method procedure LPComponent.TLPPersistent.OwnerNameChanged(String;String)|procedure OwnerNameChanged(AOldName : String; ANewName : String)]]

[[Category:Classes]]