Experimental
Optional
bearing?: numberThe initial bearing of the map, in degrees.
Optional
Experimental
debug?: booleanEnable debug mode to check the visual representation of performance stats.
Optional
initialFloor?: Floor | stringFirst floor to be rendered. By default, floor with the elevation that's closest to 0 is rendered. All floors will be sorted by elevation in ascending order.
Optional
Experimental
occlusion?: { enabled?: boolean }Enable occlusion of labels, markers and floors.
Optional
outdoorView?: {The outdoor view options.
Optional
enabled?: booleanEnable or disable the outdoor view.
Optional
layersHiddenByGeometry?: string[]Layers that should be hidden by geometry. This is useful when you want to hide certain layers when they are below the geometry.
Optional
lowDpi?: booleanReduces the pixel ratio for MapLibre rendering to improve framerate performance. When enabled, the rendering quality will be lower but performance will be better, which can be useful on devices with high-DPI displays or limited GPU capabilities.
Optional
style?: stringA url to a style specification conforming to the Maplibre Style Spec.
Use the environment
setting to switch environments.
Optional
token?: stringThe token is used to fetch outdoor tiles, which will then be rendered.
Optional
pitch?: numberThe initial pitch of the map, in degrees.
Optional
shadingAndOutlines?: booleanEnable shading of bottoms of geometry along with outlines to make geometry stand out.
Optional
Experimental
style?: {Style options for the map.
Optional
backgroundAlpha?: numberBackground alpha value. Only relevant if outdoor map is disabled.
Optional
backgroundColor?: stringBackground color. Only relevant if outdoor map is disabled.
Optional
outlines?: booleanSet the global outlines for all elements. True will enable outlines, false will disable them.
Optional
shading?: boolean | ShadingSet the global shading for all elements. True will use default values, false will disable shading.
Optional
wallTopColor?: stringSpecify a color for the top of wall geometry.
Optional
wallTopColor?: stringSpecify a color for the top of wall geometry.
Optional
zoomLevel?: numberThe initial zoom level of the map, in mercator zoom levels. If it is not specified, it will default to the level that fits the map bounds.
Options for showing a 3D map.