Style Class Reference


                    
                    
                    styleManager

Undocumented

Declaration

Swift

public private(set) weak var styleManager: StyleManager! { get }

Layers


                    
                    
                    addLayer(_:layerPosition:)

Adds a layer to the map

Throws

StyleError or type conversion errors

Declaration

Swift

public func addLayer(_ layer: Layer, layerPosition: LayerPosition? = nil) throws

Parameters

`layer`	The layer to apply on the map
`layerPosition`	Position at which to add the map.


                    
                    
                    layer(withId:)

Gets a layer from the map

Throws

StyleError or type conversion errors

Declaration

Swift

public func layer<T>(withId id: String) throws -> T where T : Layer

Parameters

`layerID`	The id of the layer to be fetched
`type`	The type of the layer that will be fetched

Return Value

The fully formed layer object of type equal to type


                    
                    
                    _layer(withId:type:)

Gets a layer from the map.

This function is useful if you do not know the concrete type of the layer you are fetching, or don’t need to know for your situation.

Throws

StyleError or type conversion errors

Declaration

Swift

public func _layer(withId id: String, type: Layer.Type) throws -> Layer

Parameters

`layerID`	The id of the layer to be fetched
`type`	The type of the layer that will be fetched

Return Value

The fully formed layer object of type equal to type


                    
                    
                    updateLayer(withId:update:)

Updates a layer that exists in the style already

Throws

StyleError or type conversion errors

Declaration

Swift

public func updateLayer<T>(withId id: String, update: (inout T) throws -> Void) throws where T : Layer

Parameters

`id`	identifier of layer to update
`type`	Type of the layer
`update`	Closure that mutates a layer passed to it

Layer properties


                    
                    
                    layerProperty(for:property:)

Gets the value of style layer property.

Declaration

Swift

public func layerProperty(for layerId: String, property: String) -> Any

Parameters

`layerId`	Style layer identifier.
`property`	Style layer property name.

Return Value

The value of the property in the layer with layerId.

Sources


                    
                    
                    addSource(_:id:)

Adds a source to the map

Throws

StyleError or type conversion errors

Declaration

Swift

public func addSource(_ source: Source, id: String) throws

Parameters

`source`	The source to add to the map.
`identifier`	A unique source identifier.


                    
                    
                    source(withId:)

Retrieves a source from the map

Throws

StyleError or type conversion errors

Declaration

Swift

public func source<T>(withId id: String) throws -> T where T : Source

Parameters

`identifier`	The id of the source to retrieve
`type`	The type of the source

Return Value

The fully formed source object of type equal to type.


                    
                    
                    _source(withId:type:)

Retrieves a source from the map

This function is useful if you do not know the concrete type of the source you are fetching, or don’t need to know for your situation.

Throws

StyleError or type conversion errors

Declaration

Swift

public func _source(withId id: String, type: Source.Type) throws -> Source

Parameters

`identifier`	The id of the source to retrieve
`type`	The type of the source

Return Value

The fully formed source object of type equal to type.


                    
                    
                    sourceProperty(for:property:)

Gets the value of style source property.

Declaration

Swift

public func sourceProperty(for sourceId: String, property: String) -> Any

Parameters

`sourceId`	Style source identifier.
`property`	Style source property name.

Return Value

The value of the property in the source with sourceId.


                    
                    
                    updateGeoJSONSource(withId:geoJSON:)

Updates the data property of a given GeoJSONSource with a new value conforming to the GeoJSONObject protocol.

Throws

StyleError or type conversion errors

Attention

This method is only effective with sources of GeoJSONSource type, and cannot be used to update other source types.

Declaration

Swift

public func updateGeoJSONSource<T>(withId id: String, geoJSON: T) throws where T : GeoJSONObject

Parameters

`id`	The identifier representing the GeoJSON source.
`geoJSON`	The new GeoJSON to be associated with the source data. i.e. a feature or feature collection.

Light


                    
                    
                    lightProperty(_:)

Gets the value of a style light property.

Declaration

Swift

public func lightProperty(_ property: String) -> Any

Parameters


                                  property

Style light property name.

Return Value

Style light property value.

Terrain


                    
                    
                    setTerrain(_:)

Sets a terrain on the style

Throws

An error describing why the operation was unsuccessful.

Declaration

Swift

public func setTerrain(_ terrain: Terrain) throws

Parameters


                                  terrain

The Terrain that should be rendered


                    
                    
                    terrainProperty(_:)

Gets the value of a style terrain property.

Declaration

Swift

public func terrainProperty(_ property: String) -> Any

Parameters


                                  property

Style terrain property name.

Return Value

Style terrain property value.


                    
                    
                    localizeLabels(into:forLayerIds:)

This function creates an expression that will localize the textField property of a SymbolLayer

Declaration

Swift

public func localizeLabels(into locale: Locale, forLayerIds layerIds: [String]? = nil) throws

Parameters

`locale`	The`Locale` to update the map to
`layerIds`	An optional list of ids that need to be localized. If `nil` is provided, all layers will be updated

StyleManagerProtocol

isLoaded
Declaration
Swift

public var isLoaded: Bool { get }
uri
Declaration
Swift

public var uri: StyleURI? { get set }
JSON
Declaration
Swift

public var JSON: String { get set }


                    
                    
                    defaultCamera

Declaration

Swift

public var defaultCamera: CameraOptions { get }


                    
                    
                    transition

Declaration

Swift

public var transition: TransitionOptions { get set }

Layers


                    
                    
                    addLayer(with:layerPosition:)

Declaration

Swift

public func addLayer(with properties: [String : Any], layerPosition: LayerPosition?) throws


                    
                    
                    _addPersistentLayer(with:layerPosition:)

Declaration

Swift

public func _addPersistentLayer(with properties: [String : Any], layerPosition: LayerPosition?) throws


                    
                    
                    _isPersistentLayer(id:)

Declaration

Swift

public func _isPersistentLayer(id: String) throws -> Bool


                    
                    
                    _addPersistentCustomLayer(withId:layerHost:layerPosition:)

Declaration

Swift

public func _addPersistentCustomLayer(withId id: String, layerHost: CustomLayerHost, layerPosition: LayerPosition?) throws


                    
                    
                    addCustomLayer(withId:layerHost:layerPosition:)

Declaration

Swift

public func addCustomLayer(withId id: String, layerHost: CustomLayerHost, layerPosition: LayerPosition?) throws


                    
                    
                    removeLayer(withId:)

Declaration

Swift

public func removeLayer(withId id: String) throws


                    
                    
                    layerExists(withId:)

Declaration

Swift

public func layerExists(withId id: String) -> Bool


                    
                    
                    allLayerIdentifiers

Declaration

Swift

public var allLayerIdentifiers: [LayerInfo] { get }

Layer Properties


                    
                    
                    _layerProperty(for:property:)

Declaration

Swift

public func _layerProperty(for layerId: String, property: String) -> StylePropertyValue


                    
                    
                    setLayerProperty(for:property:value:)

Declaration

Swift

public func setLayerProperty(for layerId: String, property: String, value: Any) throws


                    
                    
                    _layerPropertyDefaultValue(for:property:)

Declaration

Swift

public static func _layerPropertyDefaultValue(for layerType: String, property: String) -> StylePropertyValue


                    
                    
                    layerProperties(for:)

Declaration

Swift

public func layerProperties(for layerId: String) throws -> [String : Any]


                    
                    
                    setLayerProperties(for:properties:)

Declaration

Swift

public func setLayerProperties(for layerId: String, properties: [String : Any]) throws

Sources


                    
                    
                    addSource(withId:properties:)

Declaration

Swift

public func addSource(withId id: String, properties: [String : Any]) throws


                    
                    
                    removeSource(withId:)

Declaration

Swift

public func removeSource(withId id: String) throws


                    
                    
                    sourceExists(withId:)

Declaration

Swift

public func sourceExists(withId id: String) -> Bool


                    
                    
                    allSourceIdentifiers

Declaration

Swift

public var allSourceIdentifiers: [SourceInfo] { get }

Source properties


                    
                    
                    _sourceProperty(for:property:)

Declaration

Swift

public func _sourceProperty(for sourceId: String, property: String) -> StylePropertyValue


                    
                    
                    setSourceProperty(for:property:value:)

Declaration

Swift

public func setSourceProperty(for sourceId: String, property: String, value: Any) throws


                    
                    
                    sourceProperties(for:)

Declaration

Swift

public func sourceProperties(for sourceId: String) throws -> [String : Any]


                    
                    
                    setSourceProperties(for:properties:)

Declaration

Swift

public func setSourceProperties(for sourceId: String, properties: [String : Any]) throws


                    
                    
                    _sourcePropertyDefaultValue(for:property:)

Declaration

Swift

public static func _sourcePropertyDefaultValue(for sourceType: String, property: String) -> StylePropertyValue

Image source


                    
                    
                    updateImageSource(withId:image:)

Declaration

Swift

public func updateImageSource(withId id: String, image: UIImage) throws

Style images


                    
                    
                    addImage(_:id:sdf:stretchX:stretchY:content:)

Declaration

Swift

public func addImage(_ image: UIImage, id: String, sdf: Bool = false, stretchX: [ImageStretches] = [], stretchY: [ImageStretches] = [], content: ImageContent? = nil) throws


                    
                    
                    removeImage(withId:)

Declaration

Swift

public func removeImage(withId id: String) throws


                    
                    
                    image(withId:)

Declaration

Swift

public func image(withId id: String) -> UIImage?

Style


                    
                    
                    setLight(properties:)

Declaration

Swift

public func setLight(properties: [String : Any]) throws


                    
                    
                    _lightProperty(_:)

Declaration

Swift

public func _lightProperty(_ property: String) -> StylePropertyValue


                    
                    
                    setLightProperty(_:value:)

Declaration

Swift

public func setLightProperty(_ property: String, value: Any) throws

Terrain


                    
                    
                    setTerrain(properties:)

Declaration

Swift

public func setTerrain(properties: [String : Any]) throws


                    
                    
                    _terrainProperty(_:)

Declaration

Swift

public func _terrainProperty(_ property: String) -> StylePropertyValue


                    
                    
                    setTerrainProperty(_:value:)

Declaration

Swift

public func setTerrainProperty(_ property: String, value: Any) throws

Custom geometry


                    
                    
                    addCustomGeometrySource(withId:options:)

Declaration

Swift

public func addCustomGeometrySource(withId id: String, options: CustomGeometrySourceOptions) throws


                    
                    
                    _setCustomGeometrySourceTileData(forSourceId:tileId:features:)

Declaration

Swift

public func _setCustomGeometrySourceTileData(forSourceId sourceId: String, tileId: CanonicalTileID, features: [Turf.Feature]) throws


                    
                    
                    invalidateCustomGeometrySourceTile(forSourceId:tileId:)

Declaration

Swift

public func invalidateCustomGeometrySourceTile(forSourceId sourceId: String, tileId: CanonicalTileID) throws


                    
                    
                    invalidateCustomGeometrySourceRegion(forSourceId:bounds:)

Declaration

Swift

public func invalidateCustomGeometrySourceRegion(forSourceId sourceId: String, bounds: CoordinateBounds) throws