Interface TOutdoorViewOptions

Defines the options for initializing an Outdoor View. This is a union type that requires exclusive or logic, ensuring that an instance can either have headers or an authentication URL, but not both.

Note: It isn't permitted to use .headers and .authURL options simultaneously.

Hierarchy

  • TOutdoorViewOptions

Properties

attributionPosition? authURL? customAttribution? headers? layersHiddenByGeometry? lowDPI? url?

Properties

Optional attributionPosition

attributionPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right"

The position on the map where the attribution should be displayed.

Optional authURL

authURL?: string

The URL to obtain an authentication token. It isn't permitted to use .headers and .authURL options simultaneously.

Optional customAttribution

customAttribution?: string | string[]

Custom text or an array of texts to be used for the map attribution.

Optional headers

headers?: {
    [key: string]: string | null;
}

An object containing HTTP headers for authentication purposes. It isn't permitted to use .headers and .authURL options simultaneously.

Type declaration

  • [key: string]: string | null

Optional layersHiddenByGeometry

layersHiddenByGeometry?: string[]

Outdoor map layers which should be hidden under the indoor geometry.

Default

['building-top']

Optional lowDPI

lowDPI?: boolean

If set to true, the map will be rendered in dpi=1 mode, which should make performance better

Optional url

url?: string

The URL to the map style file.

Settings

Member Visibility

Theme

On This Page