MixedSignalGraph class/Annotation List property

From LabVIEW Wiki
Jump to: navigation, search
VI Server Property Information
Property ID 393E8C12
Scope Basic Development Environment
Data Name AnntList Copy
Short Name* AnntList
Long Name* Annotation List
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 92
Owning Class Name MixedSignalGraph Class
Data Type Common Cluster Array TypeDef data type

Common Cluster Array TypeDef

Property Node Annotation List
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Need to authenticate before useNo
PermissionsRead/Write
Remote access allowedYes
Settable when the VI is runningYes

Array of information about all annotations. Each array element is a cluster of annotation elements.

Elements
Name Description
Name The text displayed in the plot area that is associated with the annotation.
Color The color of the annotation, including its point, arrow, and name.
Style The symbol that, in combination with Point Style, is drawn at the focal point of the annotation. Valid values are 0-8, as shown on the Annotation Style shortcut menu item of the annotation from top-left to bottom-right.
Point Style The symbol that, in combination with Style, is drawn at the focal point of the annotation. Valid values are 0-16, as shown on the Point Style shortcut menu item of the annotation from top-left to bottom-right.
Name Visible If TRUE, displays the annotation name in the plot area.
Allow Drag If TRUE, allows you to drag the annotation.
Annotation Mode Specifies the way in which the annotation snaps to the plots in the plot area. Valid values include 0 (Free) and 1 (Single-plot).
Plot The plot with which the annotation is associated. If Plot is -1, the annotation snaps to all plots in the plot area. You can move the annotation to the nearest data point along any plot in the plot area. This element does not apply to free annotations.
Index The array index of the point to which the annotation is snapped.
Position:X The x coordinate of the annotation in the plot area. Position:X is in the coordinate system of the X Scale value that is associated with the annotation or plot.
Position:Y The y coordinate of the annotation in the plot area. Position:Y is in the coordinate system of the Y Scale value that is associated with the annotation or plot.
X Scale The x-scale associated with the annotation. This element applies only to free annotations and defines which x-scale is used with Position:X.
Y Scale The y-scale associated with the annotation. This element applies only to free annotations and defines which y-scale is used with Position:Y.
Show Arrow If TRUE, displays the arrow that points from the annotation name to the annotated data point.
Lock Name If TRUE, positions the annotation name absolutely so that when you move the annotation or scroll the plot area, the annotation name does not move in the plot area.
Plot Area The plot area with which the annotation is associated. This element applies only to mixed signal graphs with multiple plot areas.
Label Offset:X The X coordinate of the label position, relative to the annotation.
Label Offset:Y The Y coordinate of the label position, relative to the annotation.

Uses

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links