Skip to main content
Version: 8.1

Vision - Compass

Component Palette Icon

The compass is a component that displays up to three needles at once on a cardinal direction compass. This can be useful for plotting anything that has a cardinal direction, such as the wind direction. Each needle can use one of nine different styles. Use the "Disabled" style to turn off any needle.

Properties

PropertyDescriptionProperty TypeScriptingCategory
BorderThe border surrounding this component. Options are No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), and Field Border.
Note: The border is unaffected by rotation.

Changed in 8.1.21
As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Border.borderCommon
Center ColorThe center color of the compass. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector .Color.centerColorAppearance
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.int.cursorCodeCommon
Label FontThe font to use for the compass's labels.Font.labelFontAppearance
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Rose ColorThe background color of the rose. See Color Selector .Color.roseColorAppearance
Rose HighlightThe highlight color of the rose. See Color Selector.Color.roseHighlightColorAppearance
StylesContains the component's styles.Dataset.stylesAppearance
Value 1Value 1 for the compass.double.value1Data
Value 1 ColorThe main color for Value 1's needle. See Color Selector.Color.value1ColorAppearance
Value 1 NeedleThe needle type for this value.int.value1NeedleData
Value 1 OutlineThe outline color for value 1's needle. See Color Selector.Color.value1OutlineColorAppearance
Value 2Value 2 for the compass.double.value2Data
Value 2 ColorThe main color for Value 2's needle. See Color Selector.Color.value2ColorAppearance
Value 2 NeedleThe needle type for this value.int.value2NeedleData
Value 2 OutlineThe outline color for Value 2's needle. See Color Selector.Color.value2OutlineColorAppearance
Value 3Value 3 for the compass.double.value3Data
Value 3 ColorThe main color for Value 3's needle. See Color Selector.Color.value3ColorAppearance
Value 3 NeedleThe needle type for this value.int.value3NeedleData
Value 3 OutlineThe outline color for Value 3's needle. See Color Selector.Color.value3OutlineColorAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon

Scripting

See the Vision - Compass Scripting Functions page for the full list of scripting functions available for this component.

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page

Customizers

Examples

Property NameValue
Center Color0,217,0
Rose Color172,95,0
Label FontTimes New Roman, Bold, 14
Value 1140
Value 1 Color255,0,0
Value 1 NeedlePointer