Jump to content

WaveformGraph class

From LabVIEW Wiki
Revision as of 20:18, 1 September 2019 by Q (talk | contribs)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name WaveformGraph class
Class ID 24
Scope Basic Development Environment
Class Inheritance
Class Children


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

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

Properties

Show/Hide WaveformGraph Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
WaveformGraph Properties Table
Property ID Short Name (English) Description R/W RTE
6343405 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 or chart, 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 Cursor property to get the user selected cursor.

R/W X
6343403 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 waveform 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
634341C 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
6343406 Cursor Reference to active cursor.

You can use this reference with the Cursor properties.

R X
6343410 Cursor Legend Vis Displays the cursor legend. This property is similar to the Visible Items»Cursor Legend item on the shortcut menu of a waveform graph control. R/W X
634341B 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
6343422 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
6343413 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
6343412 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
6343414 LegAutosize If TRUE, the plot legend automatically resizes to the width of the longest plot name visible in the legend.

Note On the digital waveform graph, this property works only when Switch Plot Legend to Standard View is enabled. This property is similar to the Autosize Plot Legend item on the shortcut menu of a graph. This property is also similar to the Autosize to plot names option on the Appearance page of the Waveform Graph Properties dialog box.

R/W X
6343415 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 waveform graph and the Show plot legend option on the Appearance page of the Properties dialog box.

R/W X
634341E LegNumRows Sets the number of rows in the plot legend.

Note On the digital waveform graph, this property works only when Switch Plot Legend to Standard View is enabled.

R/W X
634341D LegPlotMin Sets the minimum number of plots to keep in the plot legend. The number of entries in the plot legend will never go below this value, regardless of the data in the graph or chart.

Note On the digital waveform graph, this property works only when Switch Plot Legend to Standard View is enabled.

R/W X
6343420 PlotVisCheckboxVis Determines whether to show or hide the Plot Visibility checkbox on the plot legend. Use the checkbox to select which plots you want to display in the plot area.

This property is similar to the Visible Items»Plot Visibility Checkbox option in the shortcut menu of the plot legend of a graph or chart.

R/W X
6343409 LegPos Sets the position of the upper left corner of the graph legend in front panel coordinates. R/W X
634340A LegLeft Sets the location of the left-hand side of the graph legend in front panel coordinates.

This property is an element of the Legend:Position property.

R/W X
634340B LegTop Sets the position of the top of the graph legend in front panel coordinates.

This property is an element of the Legend:Position property.

R/W X
6343421 LegScrollPos Gets or sets the position of the scroll box in the scroll bar of the plot legend. To set the position, wire a numeric value to this property that represents the plot number to which you want to scroll. LabVIEW places the plot you specify as the first visible plot in the plot legend. To set the scroll bar to the first plot, specify a value of 0. To set the scroll bar to the second plot, specify a value of 1, and so on. R/W X
634341F LegScrollVis Shows or hides the scroll bar of the plot legend. R/W X
634340C LegSize Sets the size in pixels of the graph legend. The legend expands or contracts to the right. R/W X
634340E LegHt Sets the height in pixels of the graph legend. The legend expands down, and truncates the height to the closest value that displays an integral number of plots.

This property is an element of the Legend:Size property.

R/W X
634340D LegWidth Sets the width in pixels of the graph legend. The legend expands or contracts to the right.

This property is an element of the Legend:Size property.

R/W X
6343401 LegVis Shows the plot legend.

This property is similar to the Show plot legend option on the Appearance page of the Waveform Graph Properties dialog box.

R/W X
6343404 Plot Reference to active plot.

You can use this reference with the Plot properties.

R X
6343416 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
6343418 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
6343417 PlotImages.Middle Sets the plot area middle plot image, which is between the grid lines and the plot data. R/W X
6343408 SelectedCrsrs Displays the currently selected cursor. R/W X
6343402 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 waveform graph.

R/W X

Methods

Show/Hide WaveformGraph Methods Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
WaveformGraph Methods Table
Method ID Short Name (English) Description RTE
6343003 Export Data to Clipboard Exports the graph data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications. X
6343005 Export Data to DIAdem Exports the graph data to DIAdem. X
6343004 Export Data to Excel Exports the graph data to Excel. X
6343001 Export Image Exports an image of a waveform graph to the clipboard or disk.

This method is similar to the Export Simplified Image option on the shortcut menu of a waveform graph.

X
6343002 Export Image Color X
6343006 Export Plot Data To Clipboard Exports plot data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications. X
6343008 Export Plot Data To DIAdem Exports plot data to DIAdem. X
6343007 Export Plot Data To Excel Exports plot data to Excel. X
6343000 GetPlotAtPos Returns the plot closest to a coordinate in the coordinate system of the pane within a certain threshold. X

Events

Show/Hide WaveformGraph Events Table

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

History

History information is needed. What changes have occured over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=WaveformGraph_class&oldid=9163"