Class SLScope.TSLScope

From Mitov Wiki Doc
(Difference between revisions)
Jump to: navigation, search
(Automated Syncronization with Documentation)
 
(Automated Syncronization with Documentation)
 
(6 intermediate revisions by one user not shown)
Line 28: Line 28:
 
=== C# (.NET): ===
 
=== C# (.NET): ===
 
<code>
 
<code>
'''public ref class''' TSLScope : [[Class SLScope.TSLDataChart|Mitov.PlotLab.DataChart]]
+
'''public ref class''' Scope : [[Class SLScope.TSLDataChart|Mitov.PlotLab.DataChart]]
 
</code>
 
</code>
 
== Summary ==
 
== Summary ==
Line 35: Line 35:
 
== Description ==
 
== Description ==
 
Use this component to visualize floating point data.
 
Use this component to visualize floating point data.
 +
 +
 +
 +
<b>Diagram:</b>
 +
 +
[[Image:SLScope_Preview.png]]
  
  
Line 58: Line 64:
 
=== Published ===
 
=== Published ===
 
*[[Property SLScope.TSLScope.Vertical|Vertical]] - Specifies the Scope orientation.  
 
*[[Property SLScope.TSLScope.Vertical|Vertical]] - Specifies the Scope orientation.  
*[[Property SLScope.TSLScope.MarkerGroups|MarkerGroups]] - Collection of marker groups.
 
 
*[[Property SLScope.TSLScope.Channels|Channels]] - Collection of scope channels.  
 
*[[Property SLScope.TSLScope.Channels|Channels]] - Collection of scope channels.  
*[[Property SLScope.TSLScope.Zones|Zones]] - Collection of display zones.
+
*[[Property SLScope.TSLScope.ChannelLinks|ChannelLinks]] - Collection of scope channel links.  
*[[Property SLScope.TSLScope.Ellipses|Ellipses]] - Collection of display elliptic zones.  
+
 
*[[Property SLScope.TSLScope.Cursors|Cursors]] - Collection of measurement cursors.  
 
*[[Property SLScope.TSLScope.Cursors|Cursors]] - Collection of measurement cursors.  
 
*[[Property SLScope.TSLScope.CursorLinks|CursorLinks]] - Collection of measurement cursor links.  
 
*[[Property SLScope.TSLScope.CursorLinks|CursorLinks]] - Collection of measurement cursor links.  
*[[Property SLScope.TSLScope.ChannelLinks|ChannelLinks]] - Collection of scope channel links.  
+
*[[Property SLScope.TSLScope.MarkerGroups|MarkerGroups]] - Collection of marker groups.  
*[[Property SLScope.TSLScope.SizeLimit|SizeLimit]] - Sets the limit of samples per channel.  
+
*[[Property SLScope.TSLScope.Zones|Zones]] - Collection of display zones.
 +
*[[Property SLScope.TSLScope.Ellipses|Ellipses]] - Collection of display elliptic zones.  
 
*[[Property SLScope.TSLScope.Labels|Labels]] - Collection of display labels.  
 
*[[Property SLScope.TSLScope.Labels|Labels]] - Collection of display labels.  
 +
*[[Property SLScope.TSLScope.SizeLimit|SizeLimit]] - Sets the limit of samples per channel.
  
 
== Methods ==
 
== Methods ==
Line 72: Line 78:
 
=== Public ===
 
=== Public ===
 
*[[Method procedure SLScope.TSLScope.Invalidate()|procedure Invalidate()]] - Invalidates the visible area of the Scope.  
 
*[[Method procedure SLScope.TSLScope.Invalidate()|procedure Invalidate()]] - Invalidates the visible area of the Scope.  
 +
*[[Method function SLScope.TSLScope.GetIsVertical() : Boolean|function GetIsVertical() : Boolean]]
 
*[[Method procedure SLScope.TSLScope.SetLabelText(PChar)|procedure SetLabelText(AValue : PChar)]]
 
*[[Method procedure SLScope.TSLScope.SetLabelText(PChar)|procedure SetLabelText(AValue : PChar)]]
 
*[[Method procedure SLScope.TSLScope.Print()|procedure Print()]]
 
*[[Method procedure SLScope.TSLScope.Print()|procedure Print()]]
Line 87: Line 94:
 
*[[Property SLScope.TSLDataChart.XAxis|XAxis]] - The X Axis of the control.  
 
*[[Property SLScope.TSLDataChart.XAxis|XAxis]] - The X Axis of the control.  
 
*[[Property SLScope.TSLDataChart.Legend|Legend]] - The legend area of the control.  
 
*[[Property SLScope.TSLDataChart.Legend|Legend]] - The legend area of the control.  
*[[Property SLScope.TSLDataChart.Title|Title]] - The title area of the control.
 
 
*[[Property SLScope.TSLDataChart.DataView|DataView]] - The data view area of the component.  
 
*[[Property SLScope.TSLDataChart.DataView|DataView]] - The data view area of the component.  
*[[Property SLScope.TSLDataChart.Trails|Trails]] - Specifies the settings for the muse move trails.
 
 
*[[Property SLScope.TSLDataChart.Highlighting|Highlighting]] - Specifies the highlighting options.  
 
*[[Property SLScope.TSLDataChart.Highlighting|Highlighting]] - Specifies the highlighting options.  
 
*[[Property SLScope.TSLDataChart.CursorsStayInView|CursorsStayInView]] - Specifies if the cursors will remain within the view.  
 
*[[Property SLScope.TSLDataChart.CursorsStayInView|CursorsStayInView]] - Specifies if the cursors will remain within the view.  
Line 96: Line 101:
  
 
=== Public ===
 
=== Public ===
 +
*[[Method function SLScope.TSLDataChart.GetHighlightInfo() : TSLHighlightInfo|function GetHighlightInfo() : TSLHighlightInfo]]
 +
*[[Method function SLScope.TSLDataChart.GetHighlighting() : TSLDisplayHighlighting|function GetHighlighting() : TSLDisplayHighlighting]]
 +
*[[Method function SLScope.TSLDataChart.GetCursors() : TSLDisplayCursors|function GetCursors() : TSLDisplayCursors]]
 +
*[[Method function SLScope.TSLDataChart.GetDataView() : TSLDisplayView|function GetDataView() : TSLDisplayView]]
 
*[[Method procedure SLScope.TSLDataChart.ZoomBy(Real;Real;Boolean)|procedure ZoomBy(XValue : Real; YValue : Real; SaveHistory : Boolean)]]
 
*[[Method procedure SLScope.TSLDataChart.ZoomBy(Real;Real;Boolean)|procedure ZoomBy(XValue : Real; YValue : Real; SaveHistory : Boolean)]]
 
*[[Method procedure SLScope.TSLDataChart.ZoomTo(Real;Real;Real;Real;Boolean)|procedure ZoomTo(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)]]
 
*[[Method procedure SLScope.TSLDataChart.ZoomTo(Real;Real;Real;Real;Boolean)|procedure ZoomTo(XMin : Real; XMax : Real; YMin : Real; YMax : Real; SaveHistory : Boolean)]]
Line 114: Line 123:
 
=== Published ===
 
=== Published ===
 
*[[Property SLScope.TSLDataDisplay.Color|Color]] - The color of the display.  
 
*[[Property SLScope.TSLDataDisplay.Color|Color]] - The color of the display.  
 +
*[[Property SLScope.TSLDataDisplay.Title|Title]] - The title area of the control.
 
*[[Property SLScope.TSLDataDisplay.ToolBar|ToolBar]] - The toolbar area of the control.  
 
*[[Property SLScope.TSLDataDisplay.ToolBar|ToolBar]] - The toolbar area of the control.  
 
*[[Property SLScope.TSLDataDisplay.Zooming|Zooming]] - Specifies the behavior of the zooming.  
 
*[[Property SLScope.TSLDataDisplay.Zooming|Zooming]] - Specifies the behavior of the zooming.  
 
*[[Property SLScope.TSLDataDisplay.Cursor|Cursor]]
 
*[[Property SLScope.TSLDataDisplay.Cursor|Cursor]]
 
*[[Property SLScope.TSLDataDisplay.NavigateMode|NavigateMode]] - Specifies the navigate mode (Zoom or Pan).  
 
*[[Property SLScope.TSLDataDisplay.NavigateMode|NavigateMode]] - Specifies the navigate mode (Zoom or Pan).  
 +
*[[Property SLScope.TSLDataDisplay.Trails|Trails]] - Specifies the settings for the mouse move trails.
 
*[[Property SLScope.TSLDataDisplay.Elements|Elements]] - Component elements collection.  
 
*[[Property SLScope.TSLDataDisplay.Elements|Elements]] - Component elements collection.  
 
*[[Property SLScope.TSLDataDisplay.RefreshInterval|RefreshInterval]] - Specifies how often the view area will be updated.  
 
*[[Property SLScope.TSLDataDisplay.RefreshInterval|RefreshInterval]] - Specifies how often the view area will be updated.  
Line 132: Line 143:
 
*[[Property SLScope.TSLDataDisplay.PlotHeight|PlotHeight]]
 
*[[Property SLScope.TSLDataDisplay.PlotHeight|PlotHeight]]
 
*[[Property SLScope.TSLDataDisplay.Views|Views]]
 
*[[Property SLScope.TSLDataDisplay.Views|Views]]
*[[Property SLScope.TSLDataDisplay.|]]
 
  
 
== Methods ==
 
== Methods ==
Line 142: Line 152:
 
*[[Method procedure SLScope.TSLDataDisplay.Loaded()|procedure Loaded()]]
 
*[[Method procedure SLScope.TSLDataDisplay.Loaded()|procedure Loaded()]]
 
*[[Method procedure SLScope.TSLDataDisplay.SetParent(TWinControl)|procedure SetParent(AParent : TWinControl)]]
 
*[[Method procedure SLScope.TSLDataDisplay.SetParent(TWinControl)|procedure SetParent(AParent : TWinControl)]]
 +
*[[Method function SLScope.TSLDataDisplay.GetOperations() : TLPDrawLayerOperations|function GetOperations() : TLPDrawLayerOperations]]
 
*[[Method procedure SLScope.TSLDataDisplay.InvalidateRefresh()|procedure InvalidateRefresh()]] - Fully invalidates and flushes the draw caches of the component.  
 
*[[Method procedure SLScope.TSLDataDisplay.InvalidateRefresh()|procedure InvalidateRefresh()]] - Fully invalidates and flushes the draw caches of the component.  
 
*[[Method procedure SLScope.TSLDataDisplay.PostRefresh()|procedure PostRefresh()]]
 
*[[Method procedure SLScope.TSLDataDisplay.PostRefresh()|procedure PostRefresh()]]
Line 148: Line 159:
 
*[[Method function SLScope.TSLDataDisplay.GetAxisValueAt(Integer;Integer;Real;Real) : Boolean|function GetAxisValueAt(X : Integer; Y : Integer; var AxisX : Real; var AxisY : Real) : Boolean]] - Returns the X and Y axis value at a mouse point.  
 
*[[Method function SLScope.TSLDataDisplay.GetAxisValueAt(Integer;Integer;Real;Real) : Boolean|function GetAxisValueAt(X : Integer; Y : Integer; var AxisX : Real; var AxisY : Real) : Boolean]] - Returns the X and Y axis value at a mouse point.  
 
*[[Method procedure SLScope.TSLDataDisplay.GetChildren(TGetChildProc;TComponent)|procedure GetChildren(Proc : TGetChildProc; Root : TComponent)]]
 
*[[Method procedure SLScope.TSLDataDisplay.GetChildren(TGetChildProc;TComponent)|procedure GetChildren(Proc : TGetChildProc; Root : TComponent)]]
 +
*[[Method function SLScope.TSLDataDisplay.GetHighlightInfo() : TSLHighlightInfo|function GetHighlightInfo() : TSLHighlightInfo]]
 +
*[[Method function SLScope.TSLDataDisplay.GetHighlighting() : TSLDisplayHighlighting|function GetHighlighting() : TSLDisplayHighlighting]]
 +
*[[Method function SLScope.TSLDataDisplay.GetCursors() : TSLDisplayCursors|function GetCursors() : TSLDisplayCursors]]
 
*[[Method procedure SLScope.TSLDataDisplay.Print()|procedure Print()]] - Prints the display.  
 
*[[Method procedure SLScope.TSLDataDisplay.Print()|procedure Print()]] - Prints the display.  
 
*[[Method procedure SLScope.TSLDataDisplay.CopyToClipboard()|procedure CopyToClipboard()]] - Copies the content of the display to the Clipboard.  
 
*[[Method procedure SLScope.TSLDataDisplay.CopyToClipboard()|procedure CopyToClipboard()]] - Copies the content of the display to the Clipboard.  
 
*[[Method procedure SLScope.TSLDataDisplay.SaveToBitmap(String)|procedure SaveToBitmap(FileName : String)]] - Saves snapshot of the display into a bitmap file.  
 
*[[Method procedure SLScope.TSLDataDisplay.SaveToBitmap(String)|procedure SaveToBitmap(FileName : String)]] - Saves snapshot of the display into a bitmap file.  
 
*[[Method procedure SLScope.TSLDataDisplay.SaveToJpeg(String)|procedure SaveToJpeg(FileName : String)]] - Saves snapshot of the display into a JPEG file.  
 
*[[Method procedure SLScope.TSLDataDisplay.SaveToJpeg(String)|procedure SaveToJpeg(FileName : String)]] - Saves snapshot of the display into a JPEG file.  
 +
*[[Method function SLScope.TSLDataDisplay.GetDataView() : TSLDisplayView|function GetDataView() : TSLDisplayView]]
 +
*[[Method function SLScope.TSLDataDisplay.GetIsVertical() : Boolean|function GetIsVertical() : Boolean]]
 +
*[[Method function SLScope.TSLDataDisplay.GetColorChannelIndex(TSLDisplayView) : Integer|function GetColorChannelIndex(AView : TSLDisplayView) : Integer]]
 
*[[Method procedure SLScope.TSLDataDisplay.DoColorChannelClick(Integer)|procedure DoColorChannelClick(AItemIndex : Integer)]]
 
*[[Method procedure SLScope.TSLDataDisplay.DoColorChannelClick(Integer)|procedure DoColorChannelClick(AItemIndex : Integer)]]
 
*[[Method procedure SLScope.TSLDataDisplay.DoLayerDraw(TLPCanvas;Integer;Integer;Single;Single;Boolean)|procedure DoLayerDraw(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single; AContoursOnly : Boolean)]]
 
*[[Method procedure SLScope.TSLDataDisplay.DoLayerDraw(TLPCanvas;Integer;Integer;Single;Single;Boolean)|procedure DoLayerDraw(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single; AContoursOnly : Boolean)]]
Line 170: Line 187:
 
*[[Event SLScope.TSLDataDisplay.OnZoomChanged|OnZoomChanged]] - Occurs when the zoom has been changed.  
 
*[[Event SLScope.TSLDataDisplay.OnZoomChanged|OnZoomChanged]] - Occurs when the zoom has been changed.  
 
*[[Event SLScope.TSLDataDisplay.OnDataToolTip|OnDataToolTip]] - Occurs when the data tool tip will be shown or updated.  
 
*[[Event SLScope.TSLDataDisplay.OnDataToolTip|OnDataToolTip]] - Occurs when the data tool tip will be shown or updated.  
 +
*[[Event SLScope.TSLDataDisplay.OnPaint|OnPaint]] - Occurs when the control is redrawn.
 
*[[Event SLScope.TSLDataDisplay.OnKeyDown|OnKeyDown]]
 
*[[Event SLScope.TSLDataDisplay.OnKeyDown|OnKeyDown]]
 
*[[Event SLScope.TSLDataDisplay.OnKeyPress|OnKeyPress]]
 
*[[Event SLScope.TSLDataDisplay.OnKeyPress|OnKeyPress]]
Line 178: Line 196:
 
*[[Event SLScope.TSLDataDisplay.OnMouseMove|OnMouseMove]]
 
*[[Event SLScope.TSLDataDisplay.OnMouseMove|OnMouseMove]]
 
*[[Event SLScope.TSLDataDisplay.OnMouseUp|OnMouseUp]]
 
*[[Event SLScope.TSLDataDisplay.OnMouseUp|OnMouseUp]]
 
== From [[Class LPControlDrawLayers.TLPControlDrawLayer|TLPControlDrawLayer]] ==
 
 
== Methods ==
 
 
=== Public ===
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerBegin(TLPCanvas;Integer;Integer;Single;Single)|procedure DoLayerBegin(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single)]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerEnd()|procedure DoLayerEnd()]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerDraw(TLPCanvas;Integer;Integer;Single;Single;Boolean)|procedure DoLayerDraw(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single; AContoursOnly : Boolean)]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseMove(TShiftState;Integer;Integer)|procedure DoLayerMouseMove(AShift : TShiftState; AX : Integer; AY : Integer)]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseDown(TMouseButton;TShiftState;Integer;Integer)|procedure DoLayerMouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer)]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseUp(TMouseButton;TShiftState;Integer;Integer)|procedure DoLayerMouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer)]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseWheelDown(TShiftState;Integer;Integer)|procedure DoLayerMouseWheelDown(AShift : TShiftState; AX : Integer; AY : Integer)]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseWheelUp(TShiftState;Integer;Integer)|procedure DoLayerMouseWheelUp(AShift : TShiftState; AX : Integer; AY : Integer)]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseEnter()|procedure DoLayerMouseEnter()]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.DoLayerMouseLeave()|procedure DoLayerMouseLeave()]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.SetChachedData(TObject;TObject)|procedure SetChachedData(ALink : TObject; AData : TObject)]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.AddLayerLink(TLPLayerCollectionItem)|procedure AddLayerLink(ALink : TLPLayerCollectionItem)]]
 
*[[Method procedure LPControlDrawLayers.TLPControlDrawLayer.RemoveLayerLink(TLPLayerCollectionItem)|procedure RemoveLayerLink(ALink : TLPLayerCollectionItem)]]
 
  
 
== From [[Class SLControlCollection.TSLCustomControlItem|TSLCustomControlItem]] ==
 
== From [[Class SLControlCollection.TSLCustomControlItem|TSLCustomControlItem]] ==
Line 209: Line 208:
  
 
=== Public ===
 
=== Public ===
 +
*[[Method function SLControlCollection.TSLCustomControlItem.GetParentComponent() : TComponent|function GetParentComponent() : TComponent]]
 +
*[[Method function SLControlCollection.TSLCustomControlItem.HasParent() : Boolean|function HasParent() : Boolean]]
 
*[[Method procedure SLControlCollection.TSLCustomControlItem.SetParent(TWinControl)|procedure SetParent(AParent : TWinControl)]]
 
*[[Method procedure SLControlCollection.TSLCustomControlItem.SetParent(TWinControl)|procedure SetParent(AParent : TWinControl)]]
 
*[[Method function SLControlCollection.TSLCustomControlItem.GetHasEnable() : Boolean|function GetHasEnable() : Boolean]]
 
*[[Method function SLControlCollection.TSLCustomControlItem.GetHasEnable() : Boolean|function GetHasEnable() : Boolean]]
 
*[[Method function SLControlCollection.TSLCustomControlItem.GetCanDisable() : Boolean|function GetCanDisable() : Boolean]]
 
*[[Method function SLControlCollection.TSLCustomControlItem.GetCanDisable() : Boolean|function GetCanDisable() : Boolean]]
 
*[[Method procedure SLControlCollection.TSLCustomControlItem.SetParentComponent(TComponent)|procedure SetParentComponent(AValue : TComponent)]]
 
*[[Method procedure SLControlCollection.TSLCustomControlItem.SetParentComponent(TComponent)|procedure SetParentComponent(AValue : TComponent)]]
 
== From [[Class LPControl.TLPCustomControl|TLPCustomControl]] ==
 
 
== Properties ==
 
 
=== Published ===
 
*[[Property LPControl.TLPCustomControl.Visible|Visible]]
 
 
== Methods ==
 
 
=== Public ===
 
*[[Method procedure LPControl.TLPCustomControl.InvalidateIntRect(TRect)|procedure InvalidateIntRect(ARect : TRect)]]
 
 
== Events ==
 
*[[Event LPControl.TLPCustomControl.OnMouseEnter|OnMouseEnter]]
 
*[[Event LPControl.TLPCustomControl.OnMouseLeave|OnMouseLeave]]
 
  
 
[[Category:Controls]][[Category:Classes]]
 
[[Category:Controls]][[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.

BIGSLScope.gif SLScope.gif NETSLScope.gif

Package: SignalLabScopePkg

Unit: SLScope

Inherits: TSLDataChart

Contents

Syntax

Delphi:

type TSLScope = class( TSLDataChart )

C++ Builder:

class TSLScope : public TSLDataChart

Visual C++ (MFC):

class CTSLScope : public CTSLDataChart

C# (.NET):

public ref class Scope : Mitov.PlotLab.DataChart

Summary

Visible Scope/Plot component for representing floating point data.

Description

Use this component to visualize floating point data.


Diagram:

SLScope Preview.png


Example:

ScopeDemo.png


In Visual C++ you can instantiate the component by using the Open method:

  VCL_InitControls( m_hWnd ); // Call this function once before creating any visual controls!

  CTSLScope SLScope;
  SLScope.Open( m_HistogramDisplay.m_hWnd );

Properties

Published

Methods

Public

Events

From TSLDataChart

Properties

Published

Methods

Public

PinLists

Events

From TSLDataDisplay

Properties

Published

Public

Methods

Public

Events

From TSLCustomControlItem

Properties

Public

Methods

Public

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox