MapOptions

public struct MapOptions

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

Lifecycle


                    
                    
                    init(mapStyle:apiKey:cameraUpdate:onlineCachePolicy:cachePolicy:styleMode:)

Creates a new instance with some optional parameters.

Declaration

Swift

public init(
    mapStyle: StyleContainer? = nil,
    apiKey: String,
    cameraUpdate: CameraUpdate? = nil,
    onlineCachePolicy: OnlineCachePolicy = .default,
    cachePolicy: OnDiskCachePolicy = .default,
    styleMode: StyleMode? = nil
)

Parameters

`mapStyle`	`StyleContainer` with available `StyleDefinition`‘s.
`apiKey`	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.


                    
                    
                    init(mapStyle:apiKey:cameraUpdate:onlineCachePolicy:cachePolicy:styleMode:dataProviders:)

Creates a new instance with some optional parameters.

Declaration

Swift

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

Parameters

`mapStyle`	`StyleContainer` with available `StyleDefinition`‘s.
`apiKey`	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.
`dataProviders`	Custom data providers to provide data of map tiles.
`Important`	This is a Public Preview API. It may be changed or removed at any time.

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?
apiKey
Key used for map initialization.
Declaration
Swift

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

public let cameraUpdate: CameraUpdate?
cachePolicy
Provides a custom OnDiskCachePolicy to use for tile caching if componetization is disabled.
Declaration
Swift

public let cachePolicy: OnDiskCachePolicy
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?
dataProviders
List of custom MapDisplayDataProviders.

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

public let dataProviders: [MapDisplayDataProvider]?