CompassWidget

This widget visualizes bearing and pitch. Click it once to reset bearing to 0, click it a second time to reset pitch to 0. Supports Map and Globe view.

Props

id (string, optional)

Default: 'compass'

The id must be unique among all your widgets at a given time. It's recommended to set id explicitly. The id is used to match widgets between updates, ensuring deck.gl can distinguish between them. A default id is assigned based on widget type, so if you have multiple widgets of the same type (e.g., two compass widgets), you need to provide a custom id for at least one.

viewId (string, optional)

Default: null

The viewId prop controls how a widget interacts with views. If viewId is defined, the widget is placed in that view and interacts exclusively with it; otherwise, it is placed in the root widget container and affects all views.

placement (string, optional)

Default: 'top-left'

Widget position within the view relative to the map container. Valid options are top-left, top-right, bottom-left, bottom-right, or fill.

label (string, optional)

Tooltip message displayed while hovering a mouse over the widget.

Default: 'Compass'

transitionDuration (number, optional)

Default: 200

Bearing and pitch reset transition duration in milliseconds.

style (object, optional)

Default: {}

Additional CSS styles for the canvas.

className (string, optional)

Default: undefined

Class name to attach to the widget element. The element has the default class name of deck-widget deck-compass-widget.