Style

Defined in: style/style.ts:204

The Style base class

Extends

• Evented<MapEventType>

Methods

_markImagesChanged()

_markImagesChanged(ids: string[]): void

Defined in: style/style.ts:983

Queues the tiles that depend on these images to be reloaded on the next update, which is needed whenever an image appears, disappears or changes size.

Parameters

Returns

void

addLayer()

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

Defined in: style/style.ts:1086

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

Defined in: style/style.ts:1952

Add a sprite.

Parameters

Returns

void

destroy()

destroy(): void

Defined in: style/style.ts:2032

Destroys all internal resources of the style (sources, images, layers, etc.)

Returns

void

fire()

Call Signature

fire(event: ErrorEvent | MapStyleImageMissingEvent | MapLibreEvent<unknown> | MapSourceDataEvent | MapMovementEvent | MapContextEvent | MapStyleDataEvent | MapStyleLoadEvent | MapBoxZoomEvent | MapTouchEvent | MapMouseEvent | MapWheelEvent | MapTerrainEvent | MapLibreEvent<TouchEvent | WheelEvent> & object | MapProjectionEvent): this

Defined in: util/evented.ts:156

Calls every listener registered for the event's type.

Parameters

Returns

this

Inherited from

Evented.fire

Call Signature

fire(type: keyof MapEventType, properties?: object): this

Defined in: util/evented.ts:162

Compatibility with the (type: string, properties: Object) signature from previous versions. See https://github.com/mapbox/mapbox-gl-js/issues/6522, https://github.com/mapbox/mapbox-gl-draw/issues/766

Parameters

Returns

this

Inherited from

Evented.fire

getFilter()

getFilter(layer: string): void | FilterSpecification

Defined in: style/style.ts:1305

Get a layer's filter object

Parameters

Returns

void | FilterSpecification

the layer's filter, if any

getLayer()

getLayer(id: string): StyleLayer

Defined in: style/style.ts:1230

Return the style layer object with the given id.

Parameters

Returns

StyleLayer

a layer, if one with the given id exists

getLayersOrder()

getLayersOrder(): string[]

Defined in: style/style.ts:1239

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

Returns

string[]

ids of layers, in order

getLayoutProperty()

getLayoutProperty<K>(layerId: string, name: K): AllLayoutProperties[K]

Defined in: style/style.ts:1330

Get a layout property's value from a given layer

Type Parameters

Parameters

Returns

AllLayoutProperties[K]

the property value

getSource()

getSource(id: string): Source

Defined in: style/style.ts:1075

Get a source by ID.

Parameters

Returns

Source

source

getSprite()

getSprite(): object[]

Defined in: style/style.ts:1999

Get the current sprite value.

Returns

object[]

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

hasLayer()

hasLayer(id: string): boolean

Defined in: style/style.ts:1249

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: keyof MapEventType): boolean

Defined in: util/evented.ts:206

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

Defined in: style/style.ts:1161

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<T>(type: T, listener: (event: MapEventType[T]) => void): this

Defined in: util/evented.ts:117

Removes a previously registered event listener.

Type Parameters

Parameters

Returns

this

Inherited from

Evented.off

on()

on<T>(type: T, listener: (event: MapEventType[T]) => void): Subscription

Defined in: util/evented.ts:100

Adds a listener to a specified event type.

Type Parameters

Parameters

Returns

Subscription

Inherited from

Evented.on

once()

Call Signature

once<T>(type: T): Promise<MapEventType[T]>

Defined in: util/evented.ts:132

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.

Type Parameters

Parameters

Returns

Promise<MapEventType[T]>

a promise that resolves with the event

Inherited from

Evented.once

Call Signature

once<T>(type: T, listener: (event: MapEventType[T]) => void): this

Defined in: util/evented.ts:142

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.

Type Parameters

Parameters

Returns

this

this when a listener is provided

Inherited from

Evented.once

removeLayer()

removeLayer(id: string): void

Defined in: style/style.ts:1194

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

Defined in: style/style.ts:1033

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

Defined in: style/style.ts:1973

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<EventTypeMap>, data?: EventedParentData | (() => EventedParentData)): this

Defined in: util/evented.ts:217

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

Parameters

Returns

this

Inherited from

Evented.setEventedParent

setGeoJSONSourceData()

setGeoJSONSourceData(id: string, data: string | GeoJSON<Geometry, {[name: string]: any; }>): void

Defined in: style/style.ts:1059

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

Parameters

Returns

void

setSprite()

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

Defined in: style/style.ts:2010

Set a new value for the style's sprite.

Parameters

Returns

void

setState()

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

Defined in: style/style.ts:839

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

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

Parameters

Returns

boolean

true if any changes were made; false otherwise