LabVIEW Sound and Vibration API Reference

Octave Graph

  • Updated2024-06-18
  • 8 minute(s) read

Octave Graph


Owning Palette: Octave Spectra Controls


Requires: Sound and Vibration Measurement Suite

Displays a single octave spectrum on a standard bar graph with a logarithmic scale.

Properties

You can set Octave Graph properties in the Graph Properties: Octave Graph dialog box. You also can use the following Octave Graph properties with the Property Node.

PropertyDescription
Appearance:Label:VisibleDisplays the owned label for the object and enables the Text text box so you can edit the label. You can use the label to identify the object on the front panel and the block diagram.
Appearance:Caption:VisibleDisplays the caption for the object and enables the Text text box so you can edit the caption. You can use the caption to display a detailed description of the object on the front panel.
Appearance:Enabled StateSpecifies if the user can operate the object.
  • Enabled—Specifies that the user can operate the object.
  • Disabled—Specifies that the user cannot operate the object. The object appears as normal on the front panel.
  • Disabled & grayed—Specifies that the user cannot operate the object. The object appears dim on the front panel.
Appearance:Size:HeightHeight of the object in pixels.
Appearance:Size:WidthWidth of the object in pixels.
Appearance:Graph:Show graph paletteDisplays the graph palette.
Appearance:Graph:Show plot legendDisplays the plot legend. You can customize each plot, including the plot style, line style and width, and point style.
Appearance:Graph:Show plot legend:Auto size to plot namesResizes the plot legend to the width of the longest plot name visible in the legend.
Appearance:Graph:Show plot legend:Plots shownNumber of plots to display in the plot legend.
Appearance:Graph:Show x scroll barDisplays the horizontal scroll bar.
Appearance:Graph:Show scale legendDisplays the scale legend.
Appearance:Graph:Show cursor legendDisplays the cursor legend. You can customize each cursor, including the cursor style, line style and width, and point style.
Appearance:Graph:Update ModeUpdates the mode of the chart.
  • Strip Chart—Shows running data continuously scrolling from left to right across the chart with old data on the left and new data on the right.
  • Scope Chart—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.
  • Sweep Chart—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 left of the last value. The old data and new data are separated by a vertical line.
Appearance:Graph:Stack plotsDisplays multiple plots on the chart by using multiple vertical scales. Remove the checkmark from this checkbox to overlay the plots and display multiple plots on the chart by using a single vertical scale.
Appearance:Graph:Show digital display(s)Displays the digital display of the chart, or the numeric value of the chart.
Appearance:Graph:Show optional planeDisplays a Nyquist plane, Nichols plane, S plane, or Z plane on an XY graph.
Appearance:Graph:Cartesian LinesShows or hides the Cartesian plane lines.
Appearance:Graph:Optional plane labelsShows or hides the labels of the Nyquist plane, Nichols plane, S plane, or Z plane. Plane lines must be visible to show optional plane labels.
Appearance:Graph:Optional plane linesShows or hides the lines of the Nyquist plane, Nichols plane, S plane, or Z plane.
Display:Current ObjectDisplays the type of object you are configuring.
Display:Type:Floating pointDisplays the numeric object in floating point notation.
Display:Type:ScientificDisplays the numeric object in scientific notation.
Display:Type:Automatic formattingDisplays the numeric object in the format that LabVIEW determines is appropriate for the data.
Display:Type:SI notationDisplays the numeric object in System International (SI) notation, in which the unit of measurement appears after the value.
Display:Type:DecimalDisplays the numeric object in base-10 decimal format.
Display:Type:HexadecimalDisplays the numeric object in base-16 decimal format. Valid digits are 0 to F.
Display:Type:OctalDisplays the numeric object in base-8 format. Valid digits are 0 to 7.
Display:Type:BinaryDisplays the numeric object in base-2 format. Valid digits are 0 and 1.
Display:Type:Absolute timeDisplays the numeric object in terms of time elapsed since 12:00a.m., January 1, 1904, Universal Time. You only can set absolute time with the time stamp control.
Display:Type:Relative timeDisplays the numeric object in terms of hours, minutes, and seconds starting from zero.
Display:DigitsNumber of digits to display after the decimal point. This option is not available if Type is Decimal, Hexadecimal, Octal, or Binary.
Display:Precision TypeSets whether to display digits of precision or significant digits. Select Digits of precision if you want the Digits field to indicate the number of digits to display after the decimal point. Select Significant digits if you want the Digits field to indicate the number of significant digits to display. This option is not available if Type is Decimal, Hexadecimal, Octal, or Binary.
Display:Hide trailing zerosRemoves zeros at the end of the number. If the number has no fractional part, this option also removes the description part. This option is not available if Type is Decimal, Hexadecimal, Octal, or Binary.
Display:Exponents in multiples of 3Formats the number in engineering notation, where the exponent is always a multiple of three. This option is not available if Type is Floating Point, SI Notation, Decimal, Hexadecimal, Octal, or Binary.
Display:Use minimum field widthPads any excess space to the left or right of the number with zeros or spaces to reach the minimum width you enter in Minimum field width. Place a checkmark in this checkbox to set the Minimum field width and Padding.
Display:Use minimum field width:Minimum field widthWidth to which you want to pad the number.
Display:Use minimum field width:PaddingSpecifies whether to pad the number with space on the left, spaces on the right, or zeros on the left.
Display:Advanced editing modeContains components that allow you to specify the format and precision using format codes.
  • Format string—Formats codes to use to format the number.
  • Valid—Indicates whether the syntax of the Format string is valid.
  • Revert—Reverts Format string to the last version with valid syntax if the syntax is not valid.
  • Format code type—Sets the type of format codes to display in the Numeric format codes list.
  • Numeric format codes—Displays the format codes you can use in the Format string.
  • Insert into format string—Inserts the selected format code into the Format string.
Plots:PlotPlot you want to configure.
Plots:NameName of the plot. If the ignore attributes property is FALSE, you cannot set the plot name.
Plots:Line StyleLine style (0–4) as shown on the Plot page of the Properties dialog box ordered from top-left to bottom-right.
Plots:Line WidthLine width of the plot (0-5).
Plots:Point StylePoint Style (0–16) as shown on the Plot page of the Properties dialog box ordered from top-left to bottom-right.
Plots:Plot interpolationInterpolation of the plot.
Plots:Colors:LineColor of the line.
Plots:Colors:Point/fillColor of the point and fills.
Plots:Colors:Fill toSets the baseline of the fill.
Plots:Y-scaleThe y-scale to with which this plot is associated.
Plots:X-scaleThe x-scale to with which this plot is associated.
Scales:AxesSets the scale you want to configure.
Scales:NameName of the scale.
Scales:Show scale labelDisplays the scale label on the graph or chart.
Scales:Show scaleDisplays the scale on the graph or chart.
Scales:LogMaps the scale logarithmically. Remove the checkmark from this checkbox to map the scale linearly.
Scales:InvertedReverses the positions of the minimum and maximum values on the scale.
Scales:Expand digital busesDisplays digital waveform data as individual data lines. Remove the checkmark from this checkbox to display the data as a bus.
Scales:AutoscaleAdjusts the scale to reflect the data you wire to the graph or chart.
Scales:Autoscale:MinimumMinimum value of the scale.
Scales:Autoscale:MaximumMaximum value of the scale.
Scales:Scaling factorsValue of a scale marker and displays the marker in a convenient manner.
Scales:Scaling factors:OffsetValue of the origin of the plot.
Scales:Scaling factors:MultiplierInterval for scaling data.
Scales:Scale style and colorsStyle and colors of the marks on the scale.
Scales:Scale style and colors:Scale styleStyle of the marks on the scale.
Scales:Scale style and colors:Major tickColor of the major tick mark.
Scales:Scale style and colors:Minor tickColor of the minor tick mark.
Scales:Scale style and colors:Marker textColor of the scale marker text.
Scales:Grid style and colorsStyle and colors of the grid.
Scales:Grid style and colors:Grid styleStyle of the grid.
Scales:Grid style and colors:Major gridColor of the major grid on the scale.
Scales:Grid style and colors:Minor gridColor of the minor grid on the scale.
Scales:Ignore waveform time stamp on x-axesLabVIEW sets the beginning of the x-scale to 0 instead of the value specified by t0. Remove the checkmark from this checkbox to include the time stamp information from the dynamic or waveform data in the x-scale.
Cursors:CursorCursor you want to configure.
Cursors:NameText displayed in the plot area that is associated with the cursor.
Cursors:Line StyleSpecifies the line style of the active cursor. Valid values are 0–4, as shown on the Cursors page of the Properties dialog box ordered from top to bottom.
Cursors:Line WidthSpecifies the width of the line used to display the active cursor. Valid values are 0–4, as shown on Cursors page of the Properties dialog box ordered from top to bottom.
Cursors:Point StyleThe symbol that, in combination with Style, is drawn at the focal point of the cursor. Valid values are 0-16.
Cursor:Cursor StyleThe 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 on the Cursors page of the Properties dialog box.
Cursors:Cursor colorThe color of the cursor, including its point, arrow, and name.
Cursors:Show nameDisplays the cursor name.
Cursors:Show cursorDisplays the cursor.
Documentation:DescriptionContains a description of the object. Descriptions for controls, indicators, and constants appear in the Context Help window when you move the cursor over the object. You can enter a description for a VI or function located on the Functions palette but you can only view the description in this dialog box. The description will not appear in the Context Help window. You can format the text in the description to appear bold in the Context Help window. If you want to display a carriage return in the Context Help window, you must separate paragraphs with two carriage returns.
Documentation:Tip stripContains a brief description of the object to display when you move the cursor over an object.
Data binding:Data binding selectionServer you want to use to bind the object.
Data binding:Data binding selection:UnboundSpecifies that the object is not bound to a network-publishes project item or to an NI Publish-Subscribe-Protocol (PSP) data item on the network.
Data binding:Data binding selection:Shared variable engine (NI-PSP)Specifies that the object is bound to a network-publishes project item or to a PSP data item on the network using the Shared Variable Engine.
Data binding:Data binding selection:DataSocketSpecifies that the object is bound to a data item on the network using the DataSocket Server, or on Windows, an OPC server, an FTP server, or a Web server.
Data binding:Access typeType of access LabVIEW sets for the object you are configuring.
Data binding:Access type:Read onlySpecifies that the object reads data from a network-published project item or from a PSP data item on the network.
Data binding:Access type:Write onlySpecifies that the object writes data to a network-published item or to a PSP data item on the network.
Data binding:Access type:Read/writeSpecifies that the object reads data from and writes data to a network-published project item or a PSP data item on the network.
Data binding:PathPath to the shared variable or data item to which you want to bind the shared variable you are configuring.
Data binding:BrowseDisplays a file dialog or the Select Source Item dialog box, from which you can browse to the shared variable or data item to bind the object to.

Log in to get a better experience