|
|
| (3 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| {{VIServerClass|name=Cursor|id=38|scope=basic|class_0=Generic|class_1=Cursor}} | | {{VIServerClass|38}} |
|
| |
|
| {{stub}} | | {{stub}} |
| Line 7: |
Line 7: |
| {{TOCright}} | | {{TOCright}} |
|
| |
|
| ==Properties==
| | <!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates--> |
| <span class="mw-customtoggle-propertiestable">Show/Hide Cursor Properties Table</span>
| | {{VIServerClassTables|38}} |
| <div class="mw-collapsible" id="mw-customcollapsible-propertiestable"> | |
| {{VIServerLegend|showrw=TRUE|showrte=TRUE}}
| |
| {| class="wikitable sortable"
| |
| |+ Cursor Properties Table
| |
| ! Property ID
| |
| ! Short Name (English)
| |
| ! Description
| |
| ! R/W | |
| ! RTE
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C005
| |
| | [[Cursor class/AllowDrag property|AllowDrag]]
| |
| |If TRUE, allows you to drag the cursor.
| |
| | |
| This property is similar to the Attributes»Allow Drag item on the shortcut menu on the cursor legend of a graph and the <b>Allow Dragging</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C001
| |
| | [[Cursor class/Color property|Color]]
| |
| |The color of the cursor, including its point, arrow, and name.
| |
| | |
| You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
| |
| | |
| This property is similar to the Color item on the shortcut menu of the cursor legend of a graph and the <b>Cursor color</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C008
| |
| | [[Cursor class/Index property|Index]]
| |
| |Array index of point to which the cursor is snapped. This property can have a value between 0 and the number of data points minus 1.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C010
| |
| | [[Cursor class/CursorMode property|CursorMode]]
| |
| |Specifies the way in which the cursor snaps to the plots in the plot area. Valid values include 0 (Free), 1 (Single-plot), and 2 (Multi-plot).
| |
| | |
| This property is similar to the Create Cursor items in the shortcut menu of the cursor legend of a graph.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C000
| |
| | [[Cursor class/Name property|Name]]
| |
| |Text displayed in the plot area that is associated with the cursor.
| |
| | |
| This property is similar to the name text box in the cursor legend of a graph and the <b>Name</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C004
| |
| | [[Cursor class/NameVis property|NameVis]]
| |
| |If TRUE, displays the cursor name in the plot area.
| |
| | |
| This property is similar to the Show Name item of the shortcut menu of the cursor legend of a graph and the <b>Show name</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C007
| |
| | [[Cursor class/Plot property|Plot]]
| |
| |Plot with which the cursor is associated. If Plot is –1, the cursor snaps to all plots in the plot area. You can move the cursor to the nearest data point along any plot in the plot area.
| |
| | |
| This property is similar to the cursor plot items of the shortcut menu of the cursor legend of a graph and the <b>Cursor plot</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C003
| |
| | [[Cursor class/PointStyle property|PointStyle]]
| |
| |The symbol that, in combination with Style, is drawn at the focal point of the cursor. Valid values are 0-16, as shown on the shortcut menu of the plot legend from top-left to bottom-right.
| |
| | |
| This property is similar to the Point Style item of the shortcut menu of the cursor legend of a graph and the <b>Point Style</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C009
| |
| | [[Cursor class/Position property|Position]]
| |
| |Position of cursor in terms of X-Y coordinates.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C00A
| |
| | [[Cursor class/PosX property|PosX]]
| |
| |The X coordinate of the cursor in the plot area. Position:X is in the coordinate system of the X Scale value that is associated with the cursor or plot.
| |
| | |
| This property is an element of the Cursor Position property.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C00B
| |
| | [[Cursor class/PosY property|PosY]]
| |
| |The Y coordinate of the cursor in the plot area. Position:Y is in the coordinate system of the Y Scale value that is associated with the cursor or plot.
| |
| | |
| This property is an element of the Cursor Position property.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C016
| |
| | [[Cursor class/SelectionColor property|SelectionColor]]
| |
| |Color of the cursor row selected in the cursor legend.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C002
| |
| | [[Cursor class/Style property|Style]]
| |
| |The symbol that, in combination with Point Style, is drawn at the focal point of the cursor. Valid values are 0-8, from top-left to bottom-right, as shown when you right-click a cursor in the cursor legend and select <b>Attributes»Cursor Style</b> from the shortcut menu.
| |
| | |
| This property is similar to the Cursor Style item of the shortcut menu of the cursor legend of a graph and the <b>Cursor Style</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C00E
| |
| | [[Cursor class/LineStyle property|LineStyle]]
| |
| |Specifies the line style of the active cursor. Valid values are 0–4, as shown on the shortcut menu of the plot legend and on the <b>Cursors</b> page of the Properties dialog box ordered from top to bottom.
| |
| | |
| This property is similar to the Line Style item of the shortcut menu of the cursor legend of a graph and the <b>Line style</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C00F
| |
| | [[Cursor class/LineWidth property|LineWidth]]
| |
| |Specifies the width of the line used to display the active cursor. Valid values are 0–4, as shown on the shortcut menu of the plot legend and on the <b>Cursors</b> page of the Properties dialog box ordered from top to bottom.
| |
| | |
| Assigning a value of 0 results in a line width of exactly one pixel. Assigning values 1–4 will result in a line width of increasing thickness based upon the resolution of the monitor.
| |
| | |
| This property is similar to the Line Width item of the shortcut menu of the cursor legend of a graph and the <b>Line width</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C015
| |
| | [[Cursor class/PlotArea property|PlotArea]]
| |
| |The plot area with which the cursor is associated. This property applies only to Mixed Signal graphs.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C00C
| |
| | [[Cursor class/Visible property|Visible]]
| |
| |Shows the cursor.
| |
| | |
| This property is similar to the <b>Show cursor</b> option on the <b>Cursors</b> page of the Properties dialog box.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C014
| |
| | [[Cursor class/WatchAllPlots property|WatchAllPlots]]
| |
| |If TRUE, the cursor watches all plots in the plot area. If FALSE, the cursor watches only the plots specified by the Watch Plots property. This property is valid only for cursors that are associated with multiple plots.
| |
| | |
| This property is similar to the <b>Watch»All Plots</b> item on the shortcut menu of the cursor legend of a mixed signal graph.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C013
| |
| | [[Cursor class/WatchPlots property|WatchPlots]]
| |
| |Array that contains the indexes of the plots that the cursor is watching when the Watch All Plots property is set to FALSE. This property is valid only for cursors that are associated with multiple plots.
| |
| | |
| This property is similar to the <b>Watch</b> items on the shortcut menu of the cursor legend of a mixed signal graph.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C011
| |
| | [[Cursor class/XScale property|XScale]]
| |
| |Sets the x-scale of the cursor. This property is valid only for free cursors. When the cursor is associated with a plot, this property might be overwritten by the plot.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |632C012
| |
| | [[Cursor class/YScale property|YScale]]
| |
| |Sets the y-scale of the cursor. This property is valid only for free cursors. When the cursor is associated with a plot, this property might be overwritten by the plot.
| |
| |R/W
| |
| |X
| |
| |} | |
| </div>
| |
| | |
| ==Methods==
| |
| ''No Methods for this class.''
| |
| | |
| ==Events==
| |
| ''No Events for this class.''
| |
|
| |
|
| == History == | | == History == |
| {{ambox|text=History information is needed. What changes have occured over previous versions?}} | | {{ambox|text=History information is needed. What changes have occurred over previous versions?}} |
| {| class="wikitable" | | {| class="wikitable" |
| ! Version | | ! Version |
| Line 201: |
Line 24: |
| *[[VI Server]] | | *[[VI Server]] |
|
| |
|
| [[Category:VI Server]]
| |
| [[Category:VI Server Class]] | | [[Category:VI Server Class]] |
The Cursor class is a class in the VI Server Class Hierarchy, (see also VI Server).
Properties
Show/Hide Cursor Properties Table
Cursor Properties Table
| Property ID
|
Long Name (English)
|
Description
|
R/W
|
RTE
|
| 632C000 | Cursor Name | Text displayed in the plot area that is associated with the cursor. | Read/Write | Yes |
| 632C001 | Cursor Color | The color of the cursor, including its point, arrow, and name. | Read/Write | Yes |
| 632C002 | Cursor Style | The symbol that, in combination with Point Style, is drawn at the focal point of the cursor. Valid values are 0-8, from top-left to bottom-right, as shown when you right-click a cursor in the cursor legend and select Attributes»Cursor Style from the shortcut menu. | Read/Write | Yes |
| 632C003 | Cursor Point Style | The symbol that, in combination with Style, is drawn at the focal point of the cursor. Valid values are 0-16, as shown on the shortcut menu of the plot legend from top-left to bottom-right. | Read/Write | Yes |
| 632C004 | Cursor Name Visible | If TRUE, displays the cursor name in the plot area. | Read/Write | Yes |
| 632C005 | Allow Drag | If TRUE, allows you to drag the cursor. | Read/Write | Yes |
| 632C006 | Cursor Lock Style | | Read/Write | Yes |
| 632C007 | Cursor Plot | Plot with which the cursor is associated. If Plot is –1, the cursor snaps to all plots in the plot area. You can move the cursor to the nearest data point along any plot in the plot area. | Read/Write | Yes |
| 632C008 | Cursor Index | Array index of point to which the cursor is snapped. This property can have a value between 0 and the number of data points minus 1. | Read/Write | Yes |
| 632C009 | Cursor Position | Position of cursor in terms of X-Y coordinates. | Read/Write | Yes |
| 632C00A | Cursor Position:Cursor X | The X coordinate of the cursor in the plot area. Position:X is in the coordinate system of the X Scale value that is associated with the cursor or plot. | Read/Write | Yes |
| 632C00B | Cursor Position:Cursor Y | The Y coordinate of the cursor in the plot area. Position:Y is in the coordinate system of the Y Scale value that is associated with the cursor or plot. | Read/Write | Yes |
| 632C00C | Visible | Shows the cursor. | Read/Write | Yes |
| 632C00D | Cursor Info | | Read/Write | Yes |
| 632C00E | Line Style | Specifies the line style of the active cursor. Valid values are 0–4, as shown on the shortcut menu of the plot legend and on the Cursors page of the Properties dialog box ordered from top to bottom. | Read/Write | Yes |
| 632C00F | Line Width | Specifies the width of the line used to display the active cursor. Valid values are 0–4, as shown on the shortcut menu of the plot legend and on the Cursors page of the Properties dialog box ordered from top to bottom. | Read/Write | Yes |
| 632C010 | Cursor Mode | Specifies the way in which the cursor snaps to the plots in the plot area. Valid values include 0 (Free), 1 (Single-plot), and 2 (Multi-plot). | Read/Write | Yes |
| 632C011 | X Scale | Sets the x-scale of the cursor. This property is valid only for free cursors. When the cursor is associated with a plot, this property might be overwritten by the plot. | Read/Write | Yes |
| 632C012 | Y Scale | Sets the y-scale of the cursor. This property is valid only for free cursors. When the cursor is associated with a plot, this property might be overwritten by the plot. | Read/Write | Yes |
| 632C013 | Watch Plots | Array that contains the indexes of the plots that the cursor is watching when the Watch All Plots property is set to FALSE. This property is valid only for cursors that are associated with multiple plots. | Read/Write | Yes |
| 632C014 | Watch All Plots | If TRUE, the cursor watches all plots in the plot area. If FALSE, the cursor watches only the plots specified by the Watch Plots property. This property is valid only for cursors that are associated with multiple plots. | Read/Write | Yes |
| 632C015 | Plot Area | The plot area with which the cursor is associated. This property applies only to Mixed Signal graphs. | Read/Write | Yes |
| 632C016 | Cursor Selection Color | Color of the cursor row selected in the cursor legend. | Read/Write | Yes |
Methods
This class has no methods or it inherits methods from its parent: Generic Class.
Events
This class has no events or it inherits events from its parent: Generic Class.
History
| Version
|
Change(s)
|
|
More info to come.
|
See Also
