MapSceneLoadOptionsBuilder

public class MapSceneLoadOptionsBuilder

extension MapSceneLoadOptionsBuilder: NativeBase

extension MapSceneLoadOptionsBuilder: Hashable

Builder for creating MapSceneLoadOptions instances. This builder ensures that either a MapScheme or a configuration file is set, but not both.

Note: This is a beta release of this feature and may contain bugs or exhibit unexpected behaviour. Related APIs are subject to change without a deprecation process.

InstantiationError
Thrown when failing to build a MapSceneLoadOptions.
Declaration
Swift

public typealias InstantiationError = InstantiationErrorDetails
init()
Creates a new builder instance.
Declaration
Swift

public init()
InstantiationErrorCode
Describes a reason for failing to build a MapSceneLoadOptions.
See more
Declaration
Swift

public enum InstantiationErrorCode : UInt32, CaseIterable, Codable


                    
                    
                    InstantiationErrorDetails

Describes the reason for failing to build a MapSceneLoadOptions.

Declaration

Swift

public struct InstantiationErrorDetails

extension MapSceneLoadOptionsBuilder.InstantiationErrorDetails : Error


                    
                    
                    withMapScheme(mapScheme:)

Sets the map scheme to load. Any configuration file set through MapSceneLoadOptionsBuilder.withConfigurationFile(...) will be discarded.

Declaration

Swift

public func withMapScheme(mapScheme: MapScheme) -> MapSceneLoadOptionsBuilder

Parameters


                                mapScheme

Map scheme to load.

Return Value

This class instance.


                    
                    
                    withConfigurationFile(configurationFile:)

Sets the configuration file path to load. Any map scheme set through MapSceneLoadOptionsBuilder.withMapScheme(...) will be discarded.

Declaration

Swift

public func withConfigurationFile(configurationFile: String) -> MapSceneLoadOptionsBuilder

Parameters


                                configurationFile

Configuration file path to load.

Return Value

This class instance.


                    
                    
                    withEnabledFeatures(enabledFeatures:)

Sets the features to enable in the new configuration.

Declaration

Swift

public func withEnabledFeatures(enabledFeatures: [String : String]) -> MapSceneLoadOptionsBuilder

Parameters


                                enabledFeatures

Features to enable. Key = feature name, value = mode name.

Return Value

This class instance.


                    
                    
                    withDisabledFeatures(disabledFeatures:)

Sets the features to disable in the new configuration.

Declaration

Swift

public func withDisabledFeatures(disabledFeatures: [String]) -> MapSceneLoadOptionsBuilder

Parameters


                                disabledFeatures

Features to disable.

Return Value

This class instance.


                    
                    
                    withWatermarkStyle(watermarkStyle:)

Sets the watermark style.

Declaration

Swift

public func withWatermarkStyle(watermarkStyle: WatermarkStyle) -> MapSceneLoadOptionsBuilder

Parameters


                                watermarkStyle

Watermark style to use.

Return Value

This class instance.


                    
                    
                    withOverridingMapStyle(overridingMapStyle:)

Sets the style to override what is defined in the scene configuration.

Declaration

Swift

public func withOverridingMapStyle(overridingMapStyle: Style) -> MapSceneLoadOptionsBuilder

Parameters


                                overridingMapStyle

Map style to override the scene configuration.

Return Value

This class instance.

build()
Builds the MapSceneLoadOptions instance.

Throws
MapSceneLoadOptionsBuilder.InstantiationError Indicates an instantiation issue.
Declaration
Swift

public func build() throws -> MapSceneLoadOptions
Return Value

A new MapSceneLoadOptions instance.