Cursor class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	Cursor class
Class ID	38
Scope	Basic Development Environment
Class Inheritance	Generic Cursor Generic Cursor
Class Children	This class has no children.

The Cursor class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Cursor Properties Table

Legend
R/W	Readable/Writable Permissions
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

Cursor Properties Table

Property ID	Short Name (English)	Description	R/W	RTE
632C005	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 Allow Dragging option on the Cursors page of the Properties dialog box.	R/W	X
632C001	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 Cursor color option on the Cursors page of the Properties dialog box.	R/W	X
632C008	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
632C010	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
632C000	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 Name option on the Cursors page of the Properties dialog box.	R/W	X
632C004	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 Show name option on the Cursors page of the Properties dialog box.	R/W	X
632C007	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 Cursor plot option on the Cursors page of the Properties dialog box.	R/W	X
632C003	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 Point Style option on the Cursors page of the Properties dialog box.	R/W	X
632C009	Position	Position of cursor in terms of X-Y coordinates.	R/W	X
632C00A	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
632C00B	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
632C016	SelectionColor	Color of the cursor row selected in the cursor legend.	R/W	X
632C002	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. This property is similar to the Cursor Style item of the shortcut menu of the cursor legend of a graph and the Cursor Style option on the Cursors page of the Properties dialog box.	R/W	X
632C00E	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 Cursors 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 Line style option on the Cursors page of the Properties dialog box.	R/W	X
632C00F	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 Cursors 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 Line width option on the Cursors page of the Properties dialog box.	R/W	X
632C015	PlotArea	The plot area with which the cursor is associated. This property applies only to Mixed Signal graphs.	R/W	X
632C00C	Visible	Shows the cursor. This property is similar to the Show cursor option on the Cursors page of the Properties dialog box.	R/W	X
632C014	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 Watch»All Plots item on the shortcut menu of the cursor legend of a mixed signal graph.	R/W	X
632C013	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 Watch items on the shortcut menu of the cursor legend of a mixed signal graph.	R/W	X
632C011	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
632C012	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

Methods

No Methods for this class.

Events

No Events for this class.

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server