Compass

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 be one of 9 different styles. Use the "Disabled" style to turn off any needle.

Appearance

Value 1 Color

The main color for Value 1's needle

Scripting name	value1Color
Data type	Color

Value 1 Outline

The outline color for value 1s needle

Scripting name	value1OutlineColor
Data type	Color

Value 2 Color

The main color for Value 2's needle

Scripting name	value2Color
Data type	Color

Value 2 Outline

The outline color for value 2s needle

Scripting name	value2OutlineColor
Data type	Color

Value 3 Color

The main color for Value 3's needle

Scripting name	value3Color
Data type	Color

Value 3 Outline

The outline color for value 3s needle

Scripting name	value3OutlineColor
Data type	Color

Label Font

The font to use for the compass's labels.

Scripting name	labelFont
Data type	Font

Rose Color

The background color of the rose.

Scripting name	roseColor
Data type	Color

Rose Highlight

The highlight color of the rose.

Scripting name	roseHighlightColor
Data type	Color

Center Color

The center color of the compass

Scripting name	centerColor
Data type	Color

Styles

Contains the component's styles

Scripting name	styles
Data type	Dataset
Flags	bindable \| expert

Common

Name

The name of this component.

Scripting name	name
Data type	String
Flags	bindable

Visible

If disabled, the component will be hidden.

Scripting name	visible
Data type	boolean
Flags	bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name	border
Data type	Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name	toolTipText
Data type	String

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Values

0	Default
1	Crosshair
2	Text
3	Wait
12	Hand
13	Move
4	SW Resize
5	SE Resize
6	NW Resize
7	NE Resize
8	N Resize
9	S Resize
10	W Resize
11	E Resize

Data

Value 1

Value 1 for the compass.

Scripting name	value1
Data type	double
Flags	bindable

Value 1 Needle

The needle type for this value.

Scripting name

value1Needle

Data type

int

Values

-1	Disabled
0	Arrow
1	Line
2	Long
3	Pin
4	Plum
5	Pointer
6	Ship
7	Wind
9	Middle Pin

Value 2

Value 2 for the compass.

Scripting name	value2
Data type	double
Flags	bindable

Value 2 Needle

The needle type for this value.

Scripting name

value2Needle

Data type

int

Values

-1	Disabled
0	Arrow
1	Line
2	Long
3	Pin
4	Plum
5	Pointer
6	Ship
7	Wind
9	Middle Pin

Value 3

Value 3 for the compass.

Scripting name	value3
Data type	double
Flags	bindable

Value 3 Needle

The needle type for this value.

Scripting name

value3Needle

Data type

int

Values

-1	Disabled
0	Arrow
1	Line
2	Long
3	Pin
4	Plum
5	Pointer
6	Ship
7	Wind
9	Middle Pin

Data Quality

The data quality code for any tag bindings on this component.

Scripting name	dataQuality
Data type	int
Flags	bindable \| expert

The following event sets are fired by this component. See Component Event Handlers to learn more.