Jump to content

Bus class: Difference between revisions

From LabVIEW Wiki
mNo edit summary
m Removed VI Sever Category from page
 
(2 intermediate revisions by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VIServer Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide Bus Properties Table</span>
{{VIServerClassTables|131}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Bus Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|632B418
| [[Bus class/BarStyle property|BarStyle]]
|Gets or sets the bar plot style.
 
This property is similar to the Bar Plots item on the shortcut menu of a plot.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B421
| [[Bus class/DigitalLineStyle property|DigitalLineStyle]]
|Sets whether LabVIEW uses a thin or thick line in the plot to distinguish high or low values or to offset a particular plot line. Applies to digital plots only.
 
This property is similar to the Line Style item on the shortcut menu of a digital waveform graph plot legend.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B420
| [[Bus class/TransitionLocation property|TransitionLocation]]
|Sets whether to display high to low transitions at the previous point, in between points, or at the new point on the x-axis. The default displays high to low transitions at the new point on the x-axis. Applies to digital plots only.
 
This property is similar to the Transition Location item on the shortcut menu of a plot.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B41F
| [[Bus class/TransitionType property|TransitionType]]
|Sets how LabVIEW distinguishes differing values in the plot. This affects only plots with more than one bit. Applies to digital plots only.
 
This property is similar to the Transition Type item on the shortcut menu of a plot.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B419
| [[Bus class/FillTo property|FillTo]]
|Fill baseline: -1 None, -2 Zero, -3 Negative Infinity, -4 Infinity. Otherwise, the number of the plot being filled.
 
This property is similar to the Fill Base Line item on the shortcut menu of a plot and the <b>Fill to</b> option on the <b>Plots</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B416
| [[Bus class/Fill/PtColor property|Fill/PtColor]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B424
| [[Bus class/FixedPointDigitsOfPrecision property|FixedPointDigitsOfPrecision]]
|Sets the number of digits of precision shown in the digital bus label when you select the <b>Fixed Point</b> label format. You can use the Label Format property to set the label format programmatically.
 
This property is similar to the <b>Digits of Precision</b> option on the Configure Fixed Point dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B422
| [[Bus class/FixedPointSettings property|FixedPointSettings]]
|Gets or sets a cluster of settings that indicate or control the fixed-point representation of a digital bus. You can use this property only if you set the bus to <b>Fixed Point</b> label format. You can use the Label Format property to set the label format programmatically.
 
The cluster that this property gets or sets includes the following components:
 
 
Signed&#8212;Boolean that specifies whether the fixed-point data is signed or unsigned.
Word Length&#8212;Long unsigned integer that specifies the total number of bits in the bit string that LabVIEW uses to represent all possible values of the fixed-point data. LabVIEW accepts a maximum word length of 64 bits.
Integer Word Length&#8212;Long signed integer that specifies the number of bits in the bit string that LabVIEW uses to represent the integer portion of the value of the fixed-point data. The integer word length can be larger than the word length, and can be positive or negative.
 
This property is similar to the <b>Encoding</b> options on the Configure Fixed Point dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B423
| [[Bus class/FixedPointStyle property|FixedPointStyle]]
|Gets or sets the formatting style of the digital bus label that LabVIEW displays when you select the <b>Fixed Point</b> label format. You can use the Label Format property to set the label format programmatically.
 
This property is similar to the <b>Style</b> option on the Configure Fixed Point dialog box.
 
 
Values
*0 Normal
*1 Scientific
*2 Engineering
*3 SI notation
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B41E
| [[Bus class/LabelFormat property|LabelFormat]]
|Gets or sets the format of the text label on a digital bus. LabVIEW displays the plot label only if there is enough room in the digital graph plot.
 
This property is similar to the Label Format item on the shortcut menu of the plot legend of a mixed signal or digital waveform graph.
 
This property is similar to the <b>Format</b> option on the Plots page of the <b>Digital Graph Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B415
| [[Bus class/LineStyle property|LineStyle]]
|Get or set the line style (0-4) as shown on the shortcut menu from top-left to bottom-right.
 
This property is similar to the Line Style item on the shortcut menu of a plot and the <b>Line Style</b> option on the <b>Plots</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B417
| [[Bus class/LineWidth property|LineWidth]]
|Get or set the width of the plot (0-5).
 
This property is similar to the Line Width item on the shortcut menu of a plot and the <b>Line Width</b> option on the <b>Plots</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B412
| [[Bus class/Color property|Color]]
|Get or set the color of the plot.
 
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
 
This property is similar to the Color item on the shortcut menu of a plot and the <b>Line color</b> option on the <b>Plots</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#D1BB80;"
|632B41D
| [[Bus class/PlotInfo property|PlotInfo]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B413
| [[Bus class/Interp property|Interp]]
|Get or set the interpolation of the plot.
 
This property is similar to the Interpolation item on the shortcut menu of a plot and the <b>Plot Interpolation</b> option on the <b>Plots</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B411
| [[Bus class/Name property|Name]]
|Get or set the name of the plot. If the Ignore Attributes property is FALSE, you cannot set the plot name.
 
This property is similar to the <b>Name</b> option on the <b>Plots</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B414
| [[Bus class/PointStyle property|PointStyle]]
|Get or set the point style (0-16) as shown on the shortcut menu from top-left to bottom-right.
 
This property is similar to the Point Style item on the shortcut menu of a plot and <b>Point Style</b> option on the <b>Plots</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B41C
| [[Bus class/Visible? property|Visible?]]
|Shows the plot.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B41A
| [[Bus class/XScaleIdx property|XScaleIdx]]
|Gets the index of X-scale with which this plot is associated.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632B41B
| [[Bus class/YScaleIdx property|YScaleIdx]]
|Gets the index of Y-scale with which this plot is associated.
|R/W
|X
|}
</div>
 
==Methods==
''No Methods for this class.''
 
==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 209: Line 24:
*[[VI Server]]
*[[VI Server]]


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

Latest revision as of 01:42, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Bus class
Class ID 131
Scope Basic Development Environment
Class Inheritance
Class Children

This class has no children.


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

Properties

Show/Hide Bus Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Bus Properties Table
Property ID Long Name (English) Description R/W RTE
632B411Plot NameGet or set the name of the plot. If the Ignore Attributes property is FALSE, you cannot set the plot name.Read/WriteYes
632B412Plot ColorGet or set the color of the plot.Read/WriteYes
632B413Plot InterpolationGet or set the interpolation of the plot.Read/WriteYes
632B414Point StyleGet or set the point style (0-16) as shown on the shortcut menu from top-left to bottom-right.Read/WriteYes
632B415Line StyleGet or set the line style (0-4) as shown on the shortcut menu from top-left to bottom-right.Read/WriteYes
632B416Fill/Point ColorGet or set the color of the point and fills.Read/WriteYes
632B417Line WidthGet or set the width of the plot (0-5).Read/WriteYes
632B418Bar Plot StyleGets or sets the bar plot style.Read/WriteYes
632B419Fill ToFill baseline: -1 None, -2 Zero, -3 Negative Infinity, -4 Infinity. Otherwise, the number of the plot being filled.Read/WriteYes
632B41AX Scale IndexGets the index of X-scale with which this plot is associated.Read/WriteYes
632B41BY Scale IndexGets the index of Y-scale with which this plot is associated.Read/WriteYes
632B41CVisibleShows the plot.Read/WriteYes
632B41DPlot InfoRead/WriteYes
632B41ELabel FormatGets or sets the format of the text label on a digital bus. LabVIEW displays the plot label only if there is enough room in the digital graph plot.Read/WriteYes
632B41FDigital Transition TypeSets how LabVIEW distinguishes differing values in the plot. This affects only plots with more than one bit. Applies to digital plots only.Read/WriteYes
632B420Digital Transition LocationSets whether to display high to low transitions at the previous point, in between points, or at the new point on the x-axis. The default displays high to low transitions at the new point on the x-axis. Applies to digital plots only.Read/WriteYes
632B421Digital Line StyleSets whether LabVIEW uses a thin or thick line in the plot to distinguish high or low values or to offset a particular plot line. Applies to digital plots only.Read/WriteYes
632B422Fixed Point SettingsGets or sets a cluster of settings that indicate or control the fixed-point representation of a digital bus. You can use this property only if you set the bus to Fixed Point label format. You can use the Label Format property to set the label format programmatically.Read/WriteYes
632B423Fixed Point StyleGets or sets the formatting style of the digital bus label that LabVIEW displays when you select the Fixed Point label format. You can use the Label Format property to set the label format programmatically.Read/WriteYes
632B424Fixed Point Digits of PrecisionSets the number of digits of precision shown in the digital bus label when you select the Fixed Point label format. You can use the Label Format property to set the label format programmatically.Read/WriteYes

Methods

This class has no methods or it inherits methods from its parent: Generic Class.

Events

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


History

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

See Also