Style

The Style base class

Extends

• Evented

Methods

addLayer()

addLayer(layerObject: AddLayerObject, before?: string, options?: StyleSetterOptions): this

Add a layer to the map style. The layer will be inserted before the layer with ID before, or appended if before is omitted.

Parameters

Returns

this

addSprite()

addSprite(id: string, url: string, options: StyleSetterOptions, completion?: (err: Error) => void): void

Add a sprite.

Parameters

Returns

void

getFilter()

getFilter(layer: string): void | FilterSpecification

Get a layer’s filter object

Parameters

Returns

void | FilterSpecification

the layer’s filter, if any

getLayer()

getLayer(id: string): StyleLayer

Return the style layer object with the given id.

Parameters

Returns

StyleLayer

a layer, if one with the given id exists

getLayersOrder()

getLayersOrder(): string[]

Return the ids of all layers currently in the style, including custom layers, in order.

Returns

string[]

ids of layers, in order

getLayoutProperty()

getLayoutProperty(layerId: string, name: string): any

Get a layout property’s value from a given layer

Parameters

Returns

any

the property value

getSource()

getSource(id: string): Source

Get a source by ID.

Parameters

Returns

Source

source

getSprite()

getSprite(): object[]

Get the current sprite value.

Returns

object[]

empty array when no sprite is set; id-url pairs otherwise

hasLayer()

hasLayer(id: string): boolean

Checks if a specific layer is present within the style.

Parameters

Returns

boolean

a boolean specifying if the given layer is present

listens()

listens(type: string): boolean

Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

Parameters

Returns

boolean

true if there is at least one registered listener for specified event type, false otherwise

Inherited from

Evented.listens

moveLayer()

moveLayer(id: string, before?: string): void

Moves a layer to a different z-position. The layer will be inserted before the layer with ID before, or appended if before is omitted.

Parameters

Returns

void

off()

off(type: string, listener: Listener): Style

Removes a previously registered event listener.

Parameters

Returns

Style

Inherited from

Evented.off

on()

on(type: string, listener: Listener): this

Adds a listener to a specified event type.

Parameters

Returns

this

Inherited from

Evented.on

once()

once(type: string, listener?: Listener): Promise<any> | Style

Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.

Parameters

Returns

Promise<any> | Style

this or a promise if a listener is not provided

Inherited from

Evented.once

removeLayer()

removeLayer(id: string): void

Remove the layer with the given id from the style. A ErrorEvent event will be fired if no such layer exists.

Parameters

Returns

void

removeSource()

removeSource(id: string): this

Remove a source from this stylesheet, given its id.

Parameters

Returns

this

Throws

if no source is found with the given ID

removeSprite()

removeSprite(id: string): void

Remove a sprite by its id. When the last sprite is removed, the whole this.stylesheet.sprite object becomes undefined. This falsy undefined value later prevents attempts to load the sprite when it’s absent.

Parameters

Returns

void

setEventedParent()

setEventedParent(parent?: Evented, data?: any): Style

Bubble all events fired by this instance of Evented to this parent instance of Evented.

Parameters

Returns

Style

Inherited from

Evented.setEventedParent

setGeoJSONSourceData()

setGeoJSONSourceData(id: string, data: string | GeoJSON): void

Set the data of a GeoJSON source, given its id.

Parameters

Returns

void

setSprite()

setSprite(sprite: SpriteSpecification, options: StyleSetterOptions, completion?: (err: Error) => void): void

Set a new value for the style’s sprite.

Parameters

Returns

void

setState()

setState(nextState: StyleSpecification, options: StyleSwapOptions & StyleSetterOptions): boolean

Update this style’s state to match the given style JSON, performing only the necessary mutations.

May throw an Error (‘Unimplemented: METHOD’) if the mapbox-gl-style-spec diff algorithm produces an operation that is not supported.

Parameters

Returns

boolean

true if any changes were made; false otherwise