Compass

Use dark colors for code blocksCopy
import "@arcgis/map-components/components/arcgis-compass";

The Compass component indicates where north is in relation to the current view rotation or camera heading.

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`icon`	`icon`	`string`
`label`	`label`	`string`
`messageOverrides`		`{ componentLabel?: string \| undefined; reset?: string \| undefined; }`
`orientation` readonly		`Orientation`
`position`	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`ArcgisLinkChart \| ArcgisMap \| ArcgisScene \| string`
`state` readonly	`state`	`"compass" \| "disabled" \| "rotation"`

autoDestroyDisabled

Property

autoDestroyDisabled: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.

Attribute: auto-destroy-disabled
Default value: false

icon

Property

icon: string

Attribute: icon

label

Property

label: string

The component's default label.

Attribute: label

messageOverrides

Property

messageOverrides: {
    componentLabel?: string | undefined;
    reset?: string | undefined;
}

Replace localized message strings with your own strings.

orientation

readonlyProperty

orientation: Orientation

The z axis orientation.

Default value: { z: 0 }

position

Property

position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"

Attribute: position
Default value: "top-left"

referenceElement

Property

referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string

Attribute: reference-element

state

readonly

Property

state: "compass" | "disabled" | "rotation"

The current state of the component.

Attribute: state
Default value: "disabled"

Methods

Method	Signature
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`destroy(): Promise<void>`
`reset`	`reset(): Promise<void>`

componentOnReady

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns: Promise<void>

destroy

Method

destroy(): Promise<void>

Returns: Promise<void>

reset

Method

reset(): Promise<void>

Returns: Promise<void>

Events

Event	Type
`arcgisPropertyChange`	`{ name: "orientation" \| "state"; }`
`arcgisReady`	`undefined`

arcgisPropertyChange

Event

arcgisPropertyChange: { name: "orientation" | "state"; }

Fired when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event

arcgisReady: undefined