Jump to content

MixedSignalGraph class

From LabVIEW Wiki
Revision as of 03:47, 30 August 2019 by Q (talk | contribs) (Started page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name class
Class ID {{{1}}}
Scope
Class Inheritance

This class is a top-level class.

Class Children

This class has no children.


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

Properties

Show/Hide MixedSignalGraph Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
MixedSignalGraph Properties Table
Property ID Short Name (English) Description R/W RTE
393E8C16 ActBus Indicates which bus on the referenced graph is active. The first bus on the graph is 0, the second bus is 1, and so on. R/W X
393E8C04 ActCrsr Use this property to get and set the active cursor and set properties and methods on that cursor.

For example, you can use the Selected Cursors property to indicate which cursor you have currently selected on a graph, then use the Active Cursor property to set that cursor to the cursor you want to modify using cursor properties and methods. The Active Cursor does not return the user selected cursor. Use the Selected Cursors property to get the user-selected cursor.

R/W X
393E8C02 ActPlot Gets or sets the active plot. After you get or set the active plot, you then can set properties or invoke methods that affect only the specified plot.

You can use the Plot properties to set the active plot.

If you are graphing multiple data types on the mixed signal graph, the graph plots are numbered as they appear wired into the Bundle function. The default active plot and first element is plot 0.

R/W X
393E8C10 ActPlotArea Gets or sets the active plot area. After you get or set the active plot area, you then can set properties and methods that affect only the specified plot area. R/W X
393E8C12 AnntList 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.
R/W X
393E8C18 Bus Returns a reference to the active bus. R X
393E8C17 BusOpen Indicates whether the active bus is open or closed. R/W X
393E8C05 Cursor Reference to active cursor.

You can use this reference with the Cursor properties.

R X
393E8C09 Cursor Legend Vis Displays the cursor legend.

This property is similar to the Visible Items»Cursor Legend item on the shortcut menu of a mixed signal graph control.

R/W X
393E8C11 CrsrList Array of information about all cursors. Each array element is a cluster of Cursor properties.
Elements:
Name Description
Name Text displayed in the plot area that is associated with the cursor.
Color The color of the cursor, including its point, arrow, and name.
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 Attribute»Cursor Style from the shortcut menu.
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.
Name Visible If TRUE, displays the cursor name in the plot area.
Allow Drag If TRUE, allows you to drag the cursor.
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).
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.
Index Array index of the point to which the cursor is snapped. This property can have a value between 0 and the number of data points minus 1.
Position Position of cursor in terms of X-Y coordinates.
  • X—The coordinate that defines the position of the cursor along the X-axis.
  • Y—The coordinate that defines the position of the cursor along the Y-axis.
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.
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.
Watch Plots Array that contains the indexes of the plots that the cursor is watching when Watch All Plots is set to FALSE. This element is valid only for cursors that are associated with multiple plots.
Watch All Plots If TRUE, the cursor watches all plots in the plot area. If FALSE, the cursor watches only the plots specified by Watch Plots. This element is valid only for cursors that are associated with multiple plots.
Plot Area The plot area with which the cursor is associated. This element applies only to Mixed Signal graphs.
Label Offset The coordinates of the label position relative to the cursor.
  • X—The X coordinate of the label position relative to the cursor.
  • Y—The Y coordinate of the label position relative to the cursor.
R/W X
393E8C1A CrsrsScrollGrph Gets or sets whether dragging the cursor outside the bounds of the graph continues to scroll the graph. Set this property to TRUE to allow scrolling outside the bounds of the graph. R/W X
393E8C0B IgnoreAttributes If FALSE (default), the plot names in the plot legend and the scale names on the graph automatically adapt to the plot names and scale names in the dynamic or waveform data attributes. If TRUE, the plot names and scale names do not adapt to the dynamic or waveform data attributes. Change this property to TRUE if you want to change the plot names and scale names. This property applies only to graphs and charts with dynamic or waveform data. R/W X
393E8C0A IgnoreTimestamp If FALSE (default), the x-scale includes the time stamp information from the dynamic or waveform data. If TRUE, LabVIEW sets the beginning of the x-scale to 0 instead of the value specified by t0. This property applies only to graphs with dynamic or waveform data. R/W X
393E8C0C LegDisable Disables the plot legend at run time.

This property is similar to the Advanced»Disable Plot Legend item on the shortcut menu of a mixed signal graph and the Show plot legend option on the Appearance page of the Properties dialog box.

R/W X
393E8C00 LegVis Shows the plot legend.

This property is similar to the Visible»Plot Legend item on the shortcut menu of a mixed signal graph.

R/W X
393E8C03 Plot Reference to active plot.

You can use this reference with the Plot properties.

R X
393E8C0D PlotImages.Back Sets the plot area background image, which is behind the grid lines.

This property is useful if you want to insert an image into the background of the graph plot area.

R/W X
393E8C0F PlotImages.Front Sets the plot area foreground image, which is in front of the plot data.

This property is useful if you want to insert an image, such as custom data point annotations, into the foreground of the graph plot area.

R/W X
393E8C0E PlotImages.Middle Sets the plot area middle plot image, which is between the grid lines and the plot data. R/W X
393E8C08 SelectedCrsrs Gets or sets the currently selected cursor. LabVIEW returns or sets the index number of the selected cursor. R/W X
393E8C19 ShowBusesWithLines When this property is TRUE, both digital buses and lines display in the digital plot areas of a mixed signal graph. When this property is FALSE, only digital lines display in the plot area of a mixed signal graph. R/W X
393E8C01 SmoothUpdt Draws graph with less flicker, but slightly slower. (Mac OS X) LabVIEW ignores this property.

This property is similar to the Advanced»Smooth Updates item on the shortcut menu of a mixed signal graph.

R/W X
393E8C13 ViewportSize Gets or sets the width and height, in pixels, of the viewing port for the referenced mixed signal graph. R/W X
393E8C15 Height Gets or sets the height, in pixels, of the viewing port for the referenced mixed signal graph. R/W X
393E8C14 Width Gets or sets the width, in pixels, of the viewing port for the referenced mixed signal graph. R/W X

Methods

Show/Hide MixedSignalGraph Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
MixedSignalGraph Methods Table
Method ID Short Name (English) Description RTE
393E8802 Export Data to Clipboard Exports the graph data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications. X
393E8804 Export Data to DIAdem Exports the graph data to DIAdem. X
393E8803 Export Data to Excel Exports the graph data to Excel. X
393E8800 Export Image Exports a simplified image of the graph to the clipboard or a file. X
393E8801 Export Image Color X
393E8805 Export Plot Data To Clipboard Exports plot data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications. X
393E8807 Export Plot Data To DIAdem Exports plot data to DIAdem. X
393E8806 Export Plot Data To Excel Exports plot data to Excel. X

Events

Show/Hide MixedSignalGraph Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
MixedSignalGraph Events Table
Code Name Type
1073741864 Cursor Grab Notify
2147483687 Cursor Grab? Filter
1073741865 Cursor Move Notify
1073741866 Cursor Release Notify

History

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

See Also