Jump to content

WaveformChart class

From LabVIEW Wiki
Revision as of 03:49, 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.


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

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

Properties

Show/Hide WaveformChart Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
WaveformChart Properties Table
Property ID Short Name (English) Description R/W RTE
6342804 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 chart, 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
6342809 DigDispsVis Indicates whether the digital displays for the chart are visible.

This property is similar to the Show digital display(s) option on the Appearance page of the Chart Properties dialog box.

R/W X
6342803 DigDisps() Reference(s) to the digital display(s). R X
6342813 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
6342811 LegAutosize If TRUE, the plot legend automatically resizes to the width of the longest plot name visible in the legend.

This property is similar to the Autosize Plot Legend item on the shortcut menu of a chart and the Auto size to plot names option on the Appearance page of the Chart Properties dialog box.

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

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

This property is not usable at run time on a stacked plot. Right-click the chart and select Overlay Plots from the shortcut menu to change from a stacked plot to an overlay plot.

R/W X
6342815 LegPlotMin Sets the minimum number of plots to keep in the plot legend. The number of entries in the plot legend never goes below this value, regardless of the data in the graph or chart. R/W X
6342817 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
634280A LegPos Sets the position of the upper left corner of the chart legend in front panel coordinates. R/W X
634280B LegLeft Sets the location of the left-hand side of the chart legend in front panel coordinates.

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

R/W X
634280C LegTop Sets the position of the top of the chart legend in front panel coordinates.

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

R/W X
6342818 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
6342816 LegScrollVis Shows or hides the scroll bar of the plot legend. R/W X
634280D LegSize Sets the size in pixels of the chart legend. The legend expands or contracts to the right. R/W X
634280F LegHt Sets the height, in pixels, of the chart 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
634280E LegWidth Sets the width, in pixels, of the chart legend. The legend expands or contracts to the right.

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

R/W X
6342801 LegVis Determines whether to show or hide the plot legend of the waveform chart.

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

R/W X
6342805 Plot Reference to active plot.

You can use this reference with the Plot properties.

R X
6342807 StackPlots Returns TRUE if the plots are stacked and FALSE if the plots are overlayed. R/W X
6342806 UpdateMode Gets or sets the update mode of the chart. Valid values include 0 (Strip), 1 (Scope), and 2 (Sweep).

This property is similar to the Advanced»Update Mode item on the shortcut menu of a chart and the Update mode option on the Appearance page of the Chart Properties dialog box.

  1. Strip—Shows running data continuously scrolling from left to right across the chart with old data on the left and new data on the right. A strip chart is similar to a paper tape strip chart recorder.
  2. Scope—Shows one item of data, such as a pulse or wave, scrolling partway across the chart from left to right. For each new value, the chart plots the value to the right of the last value. When the plot reaches the right border of the plotting area, LabVIEW erases the plot and begins plotting again from the left border. The retracing display of a scope chart is similar to an oscilloscope.
  3. Sweep—Works similarly to a scope chart except it shows the old data on the right and the new data on the left separated by a vertical line. LabVIEW does not erase the plot in a sweep chart when the plot reaches the right border of the plotting area. A sweep chart is similar to an EKG display.
 R/W X

Methods

Show/Hide WaveformChart Methods Table

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

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

X
6342801 Export Image Color X
6342805 Export Plot Data To Clipboard Exports plot data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.

You can use this reference with the Plot properties.

X
6342807 Export Plot Data To DIAdem Exports plot data to DIAdem. X
6342806 Export Plot Data To Excel Exports plot data to Excel. X

Events

No Events for this class.

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=WaveformChart_class&oldid=8984"