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

• VI Server Class Hierarchy
• VI Server