Jump to content

WaveformChart class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
m Removed VI Server Category from page
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{VIServerClass|name=WaveformChart|id=23|scope=basic|class_0=Generic|class_1=GObject|class_2=Control|class_3=GraphChart|class_4=WaveformChart}}
{{VIServerClass|23}}


{{stub}}
{{stub}}
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide WaveformChart Properties Table</span>
{{VIServerClassTables|23}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ WaveformChart Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6342804
| [[WaveformChart class/ActPlot property|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
|- style="background-color:#FFFFCC;"
|6342809
| [[WaveformChart class/DigDispsVis property|DigDispsVis]]
|Indicates whether the digital displays for the chart are visible.
 
This property is similar to the <b>Show digital display(s)</b> option on the Appearance page of the <b>Chart Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6342803
| [[WaveformChart class/DigDisps() property|DigDisps()]]
|Reference(s) to the digital display(s).
|R
|X
|- style="background-color:#FFFFCC;"
|6342813
| [[WaveformChart class/IgnoreAttributes property|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
|- style="background-color:#FFFFCC;"
|6342811
| [[WaveformChart class/LegAutosize property|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 <b>Autosize Plot Legend</b> item on the shortcut menu of a chart and the <b>Auto size to plot names</b> option on the Appearance page of the <b>Chart Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6342812
| [[WaveformChart class/LegDisable property|LegDisable]]
|Disables the plot legend at run time.
 
This property is similar to the <b>Advanced&#0187;Disable Plot Legend</b> item on the shortcut menu of a waveform chart and the <b>Show plot legend</b> option on the Appearance page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6342814
| [[WaveformChart class/LegNumRows property|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 <b>Overlay Plots</b> from the shortcut menu to change from a stacked plot to an overlay plot.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6342815
| [[WaveformChart class/LegPlotMin property|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
|- style="background-color:#FFFFCC;"
|6342817
| [[WaveformChart class/PlotVisCheckboxVis property|PlotVisCheckboxVis]]
|Determines whether to show or hide the <b>Plot Visibility</b> 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 <b>Visible Items&#0187;Plot Visibility Checkbox</b> option in the shortcut menu of the plot legend of a graph or chart.
|R/W
|X
|- style="background-color:#FFFFCC;"
|634280A
| [[WaveformChart class/LegPos property|LegPos]]
|Sets the position of the upper left corner of the chart legend in front panel coordinates.
|R/W
|X
|- style="background-color:#FFFFCC;"
|634280B
| [[WaveformChart class/LegLeft property|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
|- style="background-color:#FFFFCC;"
|634280C
| [[WaveformChart class/LegTop property|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
|- style="background-color:#FFFFCC;"
|6342818
| [[WaveformChart class/LegScrollPos property|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
|- style="background-color:#FFFFCC;"
|6342816
| [[WaveformChart class/LegScrollVis property|LegScrollVis]]
|Shows or hides the scroll bar of the plot legend.
|R/W
|X
|- style="background-color:#FFFFCC;"
|634280D
| [[WaveformChart class/LegSize property|LegSize]]
|Sets the size in pixels of the chart legend. The legend expands or contracts to the right.
|R/W
|X
|- style="background-color:#FFFFCC;"
|634280F
| [[WaveformChart class/LegHt property|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
|- style="background-color:#FFFFCC;"
|634280E
| [[WaveformChart class/LegWidth property|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
|- style="background-color:#FFFFCC;"
|6342801
| [[WaveformChart class/LegVis property|LegVis]]
|Determines whether to show or hide the plot legend of the waveform chart.
 
This property is similar to the <b>Show plot legend</b> option on the Appearance page of the <b>Chart Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6342805
| [[WaveformChart class/Plot property|Plot]]
|Reference to active plot.
 
You can use this reference with the Plot properties.
|R
|X
|- style="background-color:#CCFFFF;"
|6342807
| [[WaveformChart class/StackPlots property|StackPlots]]
|Returns TRUE if the plots are stacked and FALSE if the plots are overlayed.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6342806
| [[WaveformChart class/UpdateMode property|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 <b>Advanced&#0187;Update Mode</b> item on the shortcut menu of a chart and the <b>Update mode</b> option on the Appearance page of the <b>Chart Properties</b> dialog box.
 
<ol start="0">
<li>Strip&#8212;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.</li>
<li>Scope&#8212;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.</li>
<li>Sweep&#8212;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.</li></ol>
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide WaveformChart Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ WaveformChart Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|6342802
| [[WaveformChart class/Export Data to Clipboard method|Export Data to Clipboard]]
|Exports the chart data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.
|X
|- style="background-color:#FFFFCC;"
|6342804
| [[WaveformChart class/Export Data to DIAdem method|Export Data to DIAdem]]
|Exports the chart data to DIAdem.
|X
|- style="background-color:#FFFFCC;"
|6342803
| [[WaveformChart class/Export Data to Excel method|Export Data to Excel]]
|Exports the chart data to Excel.
|X
|- style="background-color:#FFFFCC;"
|6342800
| [[WaveformChart class/Export Image method|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
|- style="background-color:#D1BB80;"
|6342801
| [[WaveformChart class/Export Image Color method|Export Image Color]]
|
|X
|- style="background-color:#FFFFCC;"
|6342805
| [[WaveformChart class/Export Plot Data To Clipboard method|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
|- style="background-color:#FFFFCC;"
|6342807
| [[WaveformChart class/Export Plot Data To DIAdem method|Export Plot Data To DIAdem]]
|Exports plot data to DIAdem.
|X
|- style="background-color:#FFFFCC;"
|6342806
| [[WaveformChart class/Export Plot Data To Excel method|Export Plot Data To Excel]]
|Exports plot data to Excel.
|X
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
Line 255: Line 25:
*[[VI Scripting]]
*[[VI Scripting]]


[[Category:VI Server]]
 
[[Category:VI Server Class]]
[[Category:VI Server Class]]
[[Category:VI Scripting]]

Latest revision as of 02:01, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name WaveformChart class
Class ID 23
Scope Basic Development Environment
Class Inheritance
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 Long Name (English) Description R/W RTE
6342801Legend:VisibleDetermines whether to show or hide the plot legend of the waveform chart.Read/WriteYes
6342803Digital Display[]Reference(s) to the digital display(s).Read OnlyYes (Read Only)
6342804Active PlotGets 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.Read/WriteYes
6342805PlotReference to active plot.Read OnlyYes
6342806Update ModeGets or sets the update mode of the chart. Valid values include 0 (Strip), 1 (Scope), and 2 (Sweep).Read/WriteYes
6342807Stack Plots?Returns TRUE if the plots are stacked and FALSE if the plots are overlayed.Read/WriteYes (Read Only)
6342809Digital Display(s) VisibleIndicates whether the digital displays for the chart are visible.Read/WriteYes
634280ALegend:PositionSets the position of the upper left corner of the chart legend in front panel coordinates.Read/WriteYes
634280BLegend:Position:LeftSets the location of the left-hand side of the chart legend in front panel coordinates.Read/WriteYes
634280CLegend:Position:TopSets the position of the top of the chart legend in front panel coordinates.Read/WriteYes
634280DLegend:SizeSets the size in pixels of the chart legend. The legend expands or contracts to the right.Read/WriteYes
634280ELegend:Size:WidthSets the width, in pixels, of the chart legend. The legend expands or contracts to the right.Read/WriteYes
634280FLegend:Size:HeightSets 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.Read/WriteYes
6342810Legend:Plots ShownRead/WriteYes
6342811Legend:AutosizeIf TRUE, the plot legend automatically resizes to the width of the longest plot name visible in the legend.Read/WriteYes
6342812Legend:DisableDisables the plot legend at run time.Read/WriteYes
6342813Ignore AttributesIf 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.Read/WriteYes
6342814Legend:Number of RowsSets the number of rows in the plot legend.Read/WriteYes
6342815Legend:Plot MinimumSets 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.Read/WriteYes
6342816Legend:Scrollbar VisibleShows or hides the scroll bar of the plot legend.Read/WriteYes
6342817Legend:Plot Visibility Checkbox VisibleDetermines 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.Read/WriteYes
6342818Legend:Scroll PositionGets 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.Read/WriteYes

Methods

Show/Hide WaveformChart Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
WaveformChart Methods Table
Method ID Long Name (English) Description RTE
6342800Export ImageExports an image of a waveform chart to the clipboard or disk.Yes (Read/Write)
6342801Export Image ColorYes
6342802Export Data to ClipboardExports the chart data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.Yes (Read/Write)
6342803Export Data to ExcelExports the chart data to Excel.Yes (Read Only)
6342804Export Data to DIAdemExports the chart data to DIAdem.Yes (Read/Write)
6342805Export Plot Data To ClipboardExports plot data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.Yes (Read/Write)
6342806Export Plot Data To ExcelExports plot data to Excel.Yes (Read/Write)
6342807Export Plot Data To DIAdemExports plot data to DIAdem.Yes (Read Only)

Events

This class has no events or it inherits events from its parent: GraphChart Class.


History

History information is needed. What changes have occurred 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=26665"