Style

Adds a layer to the map

Adds a persistent layer to the map. Persistent layers are valid across style changes.

Moves a layer to a new layer position in the style.

Gets a layer from the map

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.

Updates a layer that exists in the style already

Adds a source to the map

Retrieves a source from the map

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.

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

true if and only if the style JSON contents, the style specified sprite, and sources are all loaded, otherwise returns false.

Get or set the style URI

Setting a new style is asynchronous. In order to get the result of this operation, listen to MapEvents.styleDataLoaded, MapEvents.styleLoaded.

Get or set the style via a JSON serialization string

The map style‘s default camera, if any, or a default camera otherwise. The map style default camera is defined as follows:

• center
• zoom
• bearing
• pitch

The style default camera is re-evaluated when a new style is loaded. Values default to 0.0 if they are not defined in the style.

Get or set the map style‘s transition options.

By default, the style parser will attempt to read the style default transition, if any, falling back to a 0.3 s transition otherwise.

Overridden transitions are reset once a new style has been loaded. To customize the transition used when switching styles, set this property after MapEvents.EventKind.styleDataLoaded where Event.type == "style" and before MapEvents.EventKind.styleDataLoaded where Event.type == "sprite" and where Event.type == "sources".

Adds a new style layer given its JSON properties

Runtime style layers are valid until they are either removed or a new style is loaded.

Adds a new persistent style layer given its JSON properties

Persistent style layers remain valid across style reloads.

Returns true if the id passed in is associated to a persistent layer

Adds a new persistent style custom layer.

Persistent style layers are valid across style reloads.

Adds a new style custom layer.

Runtime style layers are valid until they are either removed or a new style is loaded.

Removes an existing style layer

Runtime style layers are valid until they are either removed or a new style is loaded.

Checks whether a given style layer exists.

Runtime style layers are valid until they are either removed or a new style is loaded.

The ordered list of the current style layers’ identifiers and types

Gets the value of style layer property.

Gets the value of style layer property.

Sets a JSON value to a style layer property.

Gets the default value of style layer property.

Gets the properties for a style layer.

Sets style layer properties.

This method can be used to perform batch update for a style layer properties. The structure of a provided properties value must conform to the format for a corresponding layer type.

Modification of a layer identifier and/or layer type is not allowed.

Adds a new style source.

Removes an existing style source.

Checks whether a given style source exists.

The ordered list of the current style sources’ identifiers and types. Identifiers for custom vector sources will not be included

Gets the value of style source property.

Sets a value to a style source property.

Gets style source properties.

Sets style source properties.

This method can be used to perform batch update for a style source properties. The structure of a provided properties value must conform to the format for a corresponding source type. Modification of a source type is not allowed.

Gets the default value of style source property.

Updates the image of an image style source.

Adds an image to be used in the style.

This API can also be used for updating an image. If the image id was already added, it gets replaced by the new image.

The image can be used in icon-image, fill-pattern, and line-pattern.

For more information on how stretchX and stretchY parameters affect image stretching see this Mapbox GL-JS example.

Adds an image to be used in the style.

If the image has non-zero UIImage.capInsets it will be stretched accordingly, regardless of the value in UIImage.resizingMode.

Removes an image from the style.

Checks whether an image exists.

Get an image from the style.

Sets a light on the style.

Sets the style global light source properties.

Sets a value to the style light property.

Gets the value of a style light property.

Sets a terrain on the style

Removes terrain from style if it was set.

Sets the style global terrain source properties.

Sets a value to the named style terrain property.

Gets the value of a style terrain property.

Set the atmosphere of the style

Remove the atmosphere of the style. No fog, space or stars would be rendered.

Set an explicit atmosphere properties

Sets the value of a style atmosphere property.

Gets the value of a style atmosphere property.

Adds a custom geometry to be used in the style.

To add the data, implement the fetchTileFunction callback in the options and call setCustomGeometrySourceTileData.

Set tile data of a custom geometry.

Invalidate tile for provided custom geometry source.

Invalidate region for provided custom geometry source.

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

Sets the projection.

The current projection.