LabVIEW Sound and Vibration API Reference

Polar Plot

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

Polar Plot


Owning Palette: Machine Vibration Controls


Requires: Sound and Vibration Measurement Suite

Displays order magnitude and phase on a customized picture control. A polar plot enables you to see phase changes in the range of zero to 360 degrees.


You can use the following VIs to prepare and display a polar plot:


Properties

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

PropertyDescription
Plot:Plot ColorColor of the plot.
Plot:Line StyleLine style (0–4) as shown on the Plot page of the Properties dialog box ordered from top-left to bottom-right.
Plot:Line WidthWidth of the plot (0-5).
Plot:Point StylePoint Style (0–16) as shown on the Plot page of the Properties dialog box ordered from top-left to bottom-right.
Plot:Fill/Point ColorColor of the point and fills.
Cursor:VisibleShows the cursor.
Cursor:CursorInfo:VisibleIf TRUE, displays the cursor information in the plot area.
Cursor:ColorThe color of the cursor, including its point, arrow, and name.
Cursor:Cursor IndexArray index of point to which the cursor is snapped. This property can have a value between 0 and the number of data points minus 1.
Cursor: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.
Cursor: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.
Cursor:Point StyleThe symbol that, in combination with Style, is drawn at the focal point of the cursor. Valid values are 0-16.
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.
Cursor:Cursor NameText displayed in the plot area that is associated with the cursor. It shows the magnitude and phase information.
Cursor:Cursor PositionPosition of the cursor in terms of magnitude – phase coordinates.
Cursor:CursorInfo:LockPositionSpecifies whether the cursor information is movable with the cursor or fixed at the bottom-left corner.
Magnitude Scale:VisibleDisplays the magnitude scale.
Magnitude Scale:Marker Text ColorColor of the marker text of the magnitude scale.
Magnitude Scale:Name Label:TextText name of the magnitude scale label.
Magnitude Scale:Format StringSets the format string of the magnitude scale.
Magnitude Scale:Range:MaximumMaximum value of the magnitude scale.
Magnitude Scale:Grid Colors:Major ColorColor of the major grid on the magnitude scale.
Magnitude Scale:Grid Colors:Minor ColorColor of the minor grid on the magnitude scale.
Magnitude Scale:Name Label:VisibleIndicates whether the decoration is visible.
Phase Scale:VisibleDisplays the phase scale.
Phase Scale:Grid ColorColor of the grid on the phase scale.
Phase Scale:Marker Text ColorColor of the marker text of the phase scale.
Marker:VisibleIndicates if the marker is visible
Marker:ColorColor of the marker, including the point, arrow, and name.
Marker:Point StyleThe symbol that, in combination with Style, is drawn at the focal point of the marker. Valid values are 0–16.
Marker:StyleThe symbol that, in combination with Point Style, is drawn at the focal point of the marker. Valid values are 0–8.
Event:Cursor ReleaseGenerates when you releases the cursor after dragging it. This event is useful if you want to register when you finish interacting with a graph cursor. The event data is a cluster of two elements. The first element of the cluster is the index of the cursor. The second element is the cursor position in terms of magnitude – phase coordinates and reference.
Event:Scale Range ChangeGenerates when you change the scale of the Polar Plot. The maximum value changes when the you enter a new value in a scale marker. This event is useful if you want to register user changes and then adjust the functionality of the graph. The event data is a cluster of two elements. The first element of the cluster is the maximum and minimum value of the scale. The second element of the cluster is the increment of the scale.
Legend:VisibleShows the plot legend.
Legend:Strings[]Specifies the array of the items from which you can select in the selectors.
Legend:IndexSpecifies the array of the items to show on the plot.
Legend:BG ColorSpecifies the background color of the plot legend.
Legend:Font ColorSpecifies the font color of the plot legend.
Plot Area:Colors:Direction ColorColor of the direction arrow.
Plot Area:PositionPosition of the plot area of the graph in front panel coordinates.
Plot Area:SizeSize of the active plotting area in terms of width and height in pixels.
Plot Area:Colors:BG ColorBackground color of the plot.
AutoscaleScales the radius axis automatically.
AnntlistArray of information about all annotations. Each array element is a cluster of annotation elements.
Acceptance RegionAcceptance arcs or regions.