MapSceneLoadOptionsBuilder
public class MapSceneLoadOptionsBuilderextension MapSceneLoadOptionsBuilder: NativeBaseextension MapSceneLoadOptionsBuilder: HashableBuilder 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, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
-
Thrown when failing to build a
MapSceneLoadOptions.Declaration
Swift
public typealias InstantiationError = InstantiationErrorDetails -
Creates a new builder instance.
Declaration
Swift
public init() -
Describes a reason for failing to build a
See moreMapSceneLoadOptions.Declaration
Swift
public enum InstantiationErrorCode : UInt32, CaseIterable, Codable -
Describes the reason for failing to build a
See moreMapSceneLoadOptions.Declaration
Swift
public struct InstantiationErrorDetailsextension MapSceneLoadOptionsBuilder.InstantiationErrorDetails : Error -
Sets the map scheme to load. Any configuration file set through
MapSceneLoadOptionsBuilder.withConfigurationFile(...)will be discarded.Declaration
Swift
public func withMapScheme(mapScheme: MapScheme) -> MapSceneLoadOptionsBuilderParameters
mapSchemeMap scheme to load.
Return Value
This class instance.
-
Sets the configuration file path to load. Any map scheme set through
MapSceneLoadOptionsBuilder.withMapScheme(...)will be discarded.Declaration
Swift
public func withConfigurationFile(configurationFile: String) -> MapSceneLoadOptionsBuilderParameters
configurationFileConfiguration file path to load.
Return Value
This class instance.
-
Sets the features to enable in the new configuration.
Declaration
Swift
public func withEnabledFeatures(enabledFeatures: [String : String]) -> MapSceneLoadOptionsBuilderParameters
enabledFeaturesFeatures to enable. Key = feature name, value = mode name.
Return Value
This class instance.
-
Sets the features to disable in the new configuration.
Declaration
Swift
public func withDisabledFeatures(disabledFeatures: [String]) -> MapSceneLoadOptionsBuilderParameters
disabledFeaturesFeatures to disable.
Return Value
This class instance.
-
Sets the watermark style.
Declaration
Swift
public func withWatermarkStyle(watermarkStyle: WatermarkStyle) -> MapSceneLoadOptionsBuilderParameters
watermarkStyleWatermark style to use.
Return Value
This class instance.
-
Sets the style to override what is defined in the scene configuration.
Declaration
Swift
public func withOverridingMapStyle(overridingMapStyle: Style) -> MapSceneLoadOptionsBuilderParameters
overridingMapStyleMap style to override the scene configuration.
Return Value
This class instance.
-
Builds the
MapSceneLoadOptionsinstance.Throws
MapSceneLoadOptionsBuilder.InstantiationErrorIndicates an instantiation issue.Declaration
Swift
public func build() throws -> MapSceneLoadOptionsReturn Value
A new MapSceneLoadOptions instance.