VectorTileSource

Defined in: source/vector_tile_source.ts:66

A source containing vector tiles in Maplibre Vector Tile format or Mapbox Vector Tile format. (See the Style Specification for detailed documentation of options.)

Examples

map.addSource('some id', {
    type: 'vector',
    url: 'https://demotiles.maplibre.org/tiles/tiles.json'
});

map.addSource('some id', {
    type: 'vector',
    tiles: ['https://d25uarhxywzl1j.cloudfront.net/v0.1/{z}/{x}/{y}.mvt'],
    minzoom: 6,
    maxzoom: 14
});

map.getSource('some id').setUrl("https://demotiles.maplibre.org/tiles/tiles.json");

map.getSource('some id').setTiles(['https://d25uarhxywzl1j.cloudfront.net/v0.1/{z}/{x}/{y}.mvt']);

See

Add a vector tile source

Extends

Evented<SourceEventType>

Implements

Source

Methods

abortTile()

abortTile(tile: Tile): Promise<void>

Defined in: source/vector_tile_source.ts:299

Allows to abort a tile loading.

Parameters

Parameter	Type	Description
`tile`	`Tile`	The tile to abort

Returns

Promise<void>

Implementation of

Source.abortTile

hasTile()

hasTile(tileID: OverscaledTileID): boolean

Defined in: source/vector_tile_source.ts:148

True is the tile is part of the source, false otherwise.

Parameters

Parameter	Type	Description
`tileID`	`OverscaledTileID`	The tile ID

Returns

boolean

Implementation of

Source.hasTile

hasTransition()

hasTransition(): boolean

Defined in: source/vector_tile_source.ts:325

True if the source has transition, false otherwise.

Returns

boolean

Implementation of

Source.hasTransition

listens()

listens(type: string): boolean

Defined in: util/evented.ts:180

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

Parameters

Parameter	Type	Description
`type`	`string`	The event type

Returns

boolean

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

Inherited from

Evented.listens

loaded()

loaded(): boolean

Defined in: source/vector_tile_source.ts:144

True if the source is loaded, false otherwise.

Returns

boolean

Implementation of

Source.loaded

loadTile()

loadTile(tile: Tile): Promise<void | LoadTileResult>

Defined in: source/vector_tile_source.ts:205

This method does the heavy lifting of loading a tile. In most cases it will defer the work to the relevant worker source.

Parameters

Parameter	Type	Description
`tile`	`Tile`	The tile to load

Returns

Promise<void | LoadTileResult>

Implementation of

Source.loadTile

off()

off<T>(type: T, listener: (event: SourceEventType[T]) => void): this

Defined in: util/evented.ts:95

Removes a previously registered event listener.

Type Parameters

Type Parameter
`T` extends keyof `SourceEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to remove listeners for.
`listener`	(`event`: `SourceEventType`[`T`]) => `void`	The listener function to remove.

Returns

this

Inherited from

Evented.off

on()

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

Defined in: util/evented.ts:78

Adds a listener to a specified event type.

Type Parameters

Type Parameter
`T` extends keyof `SourceEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to add a listen for.
`listener`	(`event`: `SourceEventType`[`T`]) => `void`	The function to be called when the event is fired. The listener function is called with the data object passed to `fire`, extended with `target` and `type` properties.

Returns

Subscription

Inherited from

Evented.on

onAdd()

onAdd(map: Map): void

Defined in: source/vector_tile_source.ts:152

This method is called when the source is added to the map.

Parameters

Parameter	Type	Description
`map`	`Map`	The map instance

Returns

void

Implementation of

Source.onAdd

once()

Call Signature

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

Defined in: util/evented.ts:110

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

Type Parameter
`T` extends keyof `SourceEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to listen for.

Returns

Promise<SourceEventType[T]>

a promise that resolves with the event

Inherited from

Evented.once

Call Signature

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

Defined in: util/evented.ts:120

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

Type Parameter
`T` extends keyof `SourceEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to listen for.
`listener`	(`event`: `SourceEventType`[`T`]) => `void`	The function to be called when the event is fired the first time.

Returns

this

this when a listener is provided

Inherited from

Evented.once

onRemove()

onRemove(): void

Defined in: source/vector_tile_source.ts:194

This method is called when the source is removed from the map.

Returns

void

Implementation of

Source.onRemove

serialize()

serialize(): VectorSourceSpecification

Defined in: source/vector_tile_source.ts:201

Returns

VectorSourceSpecification

A plain (stringifiable) JS object representing the current state of the source. Creating a source using the returned object as the options should result in a Source that is equivalent to this one.