Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

Orbit Plot (Sound and Vibration Measurement Suite)

Displays the dynamic motion of the center of a rotating shaft.

Properties

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

PropertyDescription
Cursor: Cursor ColorSpecifies the color of the cursor, including the point, arrow, and name of the cursor.
Cursor: Cursor IndexReturns the array index of the point to which the cursor is snapped. This property can have a value between 0 and n – 1, where n is the number of data points.
Cursor: Cursor Info: Lock PositionSpecifies whether the cursor information is movable with the cursor or fixed at the bottom-left corner.
Cursor: Cursor Info: VisibleIf TRUE, displays the cursor information in the plot area.
Cursor: Cursor Point StyleSpecifies the symbol that, in combination with Style, is drawn at the focal point of the cursor. Valid values are 0-16, as shown on the Cursors page of the Properties dialog box ordered from top-left to bottom-right.
Cursor: Cursor PositionSpecifies the position of the cursor in terms of X-Y coordinates.
Cursor: Cursor StyleSpecifies the 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 ordered.
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: VisibleIf TRUE, shows the cursor.
Elliptical InfoReturns the elliptical information. Elliptical Info is read-only and is meaningful only when the plot type is filtered orbit plot. Elliptical Info includes the following information:
  • a—the major axis of ellipse of the current cursor position.
  • b—the minor axis of ellipse of the current cursor position.
  • ang—the angle between the major axis and the horizontal axis.
  • eccentricity—the measurement of how much the ellipse deviates from being circular, as calculated by .
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 three elements. The first and second elements of the cluster are the cursor position in terms of X-Y coordinates. The last element of the cluster is the index of the cursor.
Event: Scale Range ChangeGenerates when you change the minimum or maximum value of the scale of the Orbit Plot. The minimum or maximum value changes when the user enters 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 three elements. The first and second elements of the cluster are the minimum and maximum of the scale. The last element of the cluster shows which scale range has been changed.
Legend: BG ColorSpecifies the background color of the tree legend.
Legend: Font ColorSpecifies the font color of the tree legend.
Legend: IndexReturns an array of cluster. The first element of the cluster is the index value of parents' items. The second element of the cluster is the index value of children items.
Legend: Strings[]Specifies a cluster with three elements. The first BOOLEAN one is to specify whether the Orbit Plot XControl updates the Strings[] of tree legend from helper VI's input or from users customized strings; the second and third one, Row Strings[] and Column Strings[], are the array of the items from which you can select in the tree legend.
Legend: VisibleShows the tree legend.
Plot Area: Colors: Arrow/CrosshairSpecifies the color of direction arrow and the center crosshair.
Plot Area: Colors: BG ColorSpecifies the background color of the plotting area.
Plot Area: Colors: Trigger PointSpecifies the color of the trigger point, which represents the initial reference phase.
Plot: ColorSpecifies the color of the plot.
Plot: Fill/Point ColorSpecifies the color of the point and fills.
Plot: Line StyleSpecifies the Line style (0-4) as shown on the Plot page of the Properties dialog box ordered from top to bottom.
Plot: Line WidthSpecifies the line width of the plot.
Plot: Point StyleSpecifies the Point Style (0-16) as shown on the Plot page of the Properties dialog box ordered from top-left to bottom-right.
Procession DirectionIndicates the precession direction of the orbit plot: 0 – forward, 1 – backward.
Scale Range: MaximumSpecifies the maximum value of X scale and Y scale.
Scale Range: Scale FitScales the X axis and Y axis to fit the data. You can select one of the following options: 0 – Do not Autoscale, 1 – Autoscale once, 2 – Autoscale.
X Scale: Format StringSets the format string of the x-axis of the scale.
X Scale: Grid Colors: Major ColorSets the color of the major grid on the x-axis of the scale.
X Scale: Grid Colors: Minor ColorSets the color of the minor grid on the x-axis of the scale.
X Scale: Grid StyleSpecifies the style of the grid on the scale. You can select one of the following options: 0 – both the major grid color and minor grid color are set to transparent, 1 – the minor grid color is set to transparent and only the major grid color can be set, 2 – both the major grid color control and minor grid color control can be set.
X Scale: Name Label: TextDetermines the text of the x-axis scale label.
X Scale: Name Label: VisibleDisplays the x-axis scale label.
X Scale: VisibleDisplays the x-axis scale.
Y Scale: Format StringSets the format string of the y-axis of the scale.
Y Scale: Grid Colors: Major ColorSets the color of the major grid on the y-axis of the scale.
Y Scale: Grid Colors: Minor ColorSets the color of the minor grid on the y-axis of the scale.
Y Scale: Grid StyleSpecifies the style of the grid on the scale. You can select one of the following options: 0 – both the major grid color and minor grid color are set to transparent, 1 – the minor grid color is set to transparent and only the major grid color can be set, 2 – both the major grid color control and minor grid color control can be set.
Y Scale: Name Label: TextDetermines the text of the y-axis scale label.
Y Scale: Name Label: VisibleDisplays the y-axis scale label.
Y Scale: VisibleDisplays the y-axis scale.

Resources


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit