MapOptions

public struct MapOptions

Allows the user to configure the initial parameters of the map.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle


                    
                    
                    init(mapStyle:mapKey:cameraUpdate:onlineCachePolicy:cachePolicy:styleMode:tileDataProvider:dataProviders:)

Creates a new instance with some optional parameters.

Declaration

Swift

public init(
    mapStyle: StyleContainer? = nil,
    mapKey: String,
    cameraUpdate: CameraUpdate? = nil,
    onlineCachePolicy: OnlineCachePolicy = .default,
    cachePolicy: StyleCachePolicy = .default,
    styleMode: StyleMode? = nil,
    tileDataProvider: MapTileDataProviding? = nil,
    dataProviders: [MapDisplayDataProvider]? = nil
)

Parameters

`mapStyle`	`StyleContainer` with available `StyleDefinition`‘s.
`mapKey`	Key used for map initialization.
`cameraUpdate`	Provides initial `CameraUpdate` where zoom, tilt and rotation can be defined.
`cachePolicy`	Provides a custom `ResourceCachePolicy` to use for style caching.
`onlineCachePolicy`	Provides a custom `OnlineCachePolicy` to use for tile caching.
`styleMode`	Provides an initial `StyleMode` to use during map initialization.
`tileDataProvider`	Provider of map tile data
`dataProviders`	Custom data providers to provide data of map tiles.

Public

mapStyle
Provides information about what main (usually light) and dark styles are defined. Each style is defined as a StyleDefinition.
Declaration
Swift

public let mapStyle: StyleContainer?
mapKey
Key used for map initialization.
Declaration
Swift

public let mapKey: String
cameraUpdate
Provides initial CameraUpdate where zoom, tilt and rotation can be defined.
Declaration
Swift

public let cameraUpdate: CameraUpdate?
cachePolicy
Provides a custom StyleCachePolicy to use for style caching (and tile caching if componetization is not enabled).
Declaration
Swift

public let cachePolicy: StyleCachePolicy
onlineCachePolicy
Provides a custom OnlineCachePolicy to use for tile caching.
Declaration
Swift

public let onlineCachePolicy: OnlineCachePolicy
styleMode
Provides an initial StyleMode to use during map initialization. If nothing is provided, StyleMode.main will be used
Declaration
Swift

public let styleMode: StyleMode?
tileDataProvider
Map tile provider interface for map display.
Declaration
Swift

public let tileDataProvider: MapTileDataProviding?
dataProviders
List of custom MapDisplayDataProviders.
Declaration
Swift

public let dataProviders: [MapDisplayDataProvider]?