Skip to main content

Type Alias: MapTerrainControllerOptions

MapTerrainControllerOptions = object

Defined in: src/garminsdk/components/map/controllers/MapTerrainController.ts:40

Configuration options for MapTerrainController.

Properties

allowRelative?

optional allowRelative: boolean

Defined in: src/garminsdk/components/map/controllers/MapTerrainController.ts:42

Whether to allow relative terrain mode. Ignored if a user setting manager is not provided. Defaults to true.


defaultMode?

optional defaultMode: MapTerrainMode | Subscribable<MapTerrainMode>

Defined in: src/garminsdk/components/map/controllers/MapTerrainController.ts:48

The default terrain mode to which to revert if the desired terrain mode defined by user settings cannot be engaged. Ignored if a user setting manager is not provided. Defaults to MapTerrainMode.None.