WaveformGraph class

From LabVIEW Wiki
Jump to: navigation, search
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


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 Long Name (English) Description R/W RTE
6343401Legend:VisibleShows the plot legend.Read/WriteYes
6343402Smooth UpdateDraws graph with less flicker, but slightly slower. (Mac OS X) LabVIEW ignores this property.Read/WriteYes
6343403Active 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
6343404PlotReference to active plot.Read OnlyYes
6343405Active CursorUse this property to get and set the active cursor and set properties and methods on that cursor.Read/WriteYes
6343406CursorReference to active cursor.Read OnlyYes
6343407Old Cursor ListRead/WriteYes
6343408Selected CursorsDisplays the currently selected cursor.Read/WriteYes
6343409Legend:PositionSets the position of the upper left corner of the graph legend in front panel coordinates.Read/WriteYes
634340ALegend:Position:LeftSets the location of the left-hand side of the graph legend in front panel coordinates.Read/WriteYes
634340BLegend:Position:TopSets the position of the top of the graph legend in front panel coordinates.Read/WriteYes
634340CLegend:SizeSets the size in pixels of the graph legend. The legend expands or contracts to the right.Read/WriteYes
634340DLegend:Size:WidthSets the width in pixels of the graph legend. The legend expands or contracts to the right.Read/WriteYes
634340ELegend:Size:HeightSets 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.Read/WriteYes
634340FLegend:Plots ShownRead/WriteYes
6343410Cursor Legend VisibleDisplays the cursor legend. This property is similar to the Visible Items»Cursor Legend item on the shortcut menu of a waveform graph control.Read/WriteYes
6343411Older Cursor ListRead/WriteYes
6343412Ignore TimestampIf 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.Read/WriteYes
6343413Ignore 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
6343414Legend:AutosizeIf TRUE, the plot legend automatically resizes to the width of the longest plot name visible in the legend.Read/WriteYes
6343415Legend:DisableDisables the plot legend at run time.Read/WriteYes
6343416Plot Images:BackSets the plot area background image, which is behind the grid lines.Read/WriteYes
6343417Plot Images:MiddleSets the plot area middle plot image, which is between the grid lines and the plot data.Read/WriteYes
6343418Plot Images:FrontSets the plot area foreground image, which is in front of the plot data.Read/WriteYes
6343419Old Annotation ListRead/WriteYes
634341AOld Cursor ListRead/WriteYes
634341BCursor ListArray of information about all cursors. Each array element is a cluster of Cursor properties.Read/WriteYes
634341CAnnotation ListArray of information about all annotations. Each array element is a cluster of annotation elements.Read/WriteYes
634341DLegend:Plot MinimumSets 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.Read/WriteYes
634341ELegend:Number of RowsSets the number of rows in the plot legend.Read/WriteYes
634341FLegend:Scrollbar VisibleShows or hides the scroll bar of the plot legend.Read/WriteYes
6343420Legend: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
6343421Legend: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
6343422Cursors Scroll GraphGets 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.Read/WriteYes

Methods

Show/Hide WaveformGraph Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
WaveformGraph Methods Table
Method ID Long Name (English) Description RTE
6343000Get Plot At PositionReturns the plot closest to a coordinate in the coordinate system of the pane within a certain threshold.Yes (Read/Write)
6343001Export ImageExports an image of a waveform graph to the clipboard or disk.Yes (Read/Write)
6343002Export Image ColorYes
6343003Export Data to ClipboardExports the graph data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.Yes (Read/Write)
6343004Export Data to ExcelExports the graph data to Excel.Yes (Read/Write)
6343005Export Data to DIAdemExports the graph data to DIAdem.Yes (Read/Write)
6343006Export Plot Data To ClipboardExports plot data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.Yes (Read/Write)
6343007Export Plot Data To ExcelExports plot data to Excel.Yes (Read/Write)
6343008Export Plot Data To DIAdemExports plot data to DIAdem.Yes (Read/Write)

Events

Show/Hide WaveformGraph Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
WaveformGraph Events Table
Code Name Description Type
1073741864Cursor GrabGenerated when the user first clicks the graph cursor to move it. This event is useful if you want to register when a user interacts with a graph cursor.Notify
2147483687Cursor Grab?Generated when the user first clicks the cursor to move it. This event is useful if you want to register when a user interacts with a graph cursor, or if you want to disable user interaction with the graph cursors.Filter
1073741865Cursor MoveGenerated when the user moves a cursor either by clicking and dragging the cursor or using the Cursor Movement Tool.Notify
1073741866Cursor ReleaseGenerated when the user releases the cursor after dragging it. This event is useful if you want to register when a user has finished interacting with a graph cursor.Notify


History

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

See Also