Source

The Source interface must be implemented by each source type, including "core" types (vector, raster, video, etc.) and all custom, third-party types.

Event data - Fired with {dataType: 'source', sourceDataType: 'metadata'} to indicate that any necessary metadata has been loaded so that it's okay to call loadTile; and with {dataType: 'source', sourceDataType: 'content'} to indicate that the source data has changed, so that any current caches should be flushed.

Methods

abortTile()?

optional abortTile(tile: Tile): Promise<void>

Allows to abort a tile loading.

Parameters

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

Returns

Promise<void>

Defined in

src/source/source.ts:103

fire()

fire(event: Event): unknown

An ability to fire an event to all the listeners, see Evented

Parameters

Parameter	Type	Description
`event`	`Event`	The event to fire

Returns

unknown

Defined in

src/source/source.ts:77

hasTile()?

optional hasTile(tileID: OverscaledTileID): boolean

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

Parameters

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

Returns

boolean

Defined in

src/source/source.ts:98

hasTransition()

hasTransition(): boolean

True if the source has transition, false otherwise.

Returns

boolean

Defined in

src/source/source.ts:68

loadTile()

loadTile(tile: Tile): Promise<void>

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>

Defined in

src/source/source.ts:93

loaded()

loaded(): boolean

True if the source is loaded, false otherwise.

Returns

boolean

Defined in

src/source/source.ts:72

onAdd()?

optional onAdd(map: Map): void

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

Parameters

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

Returns

void

Defined in

src/source/source.ts:82

onRemove()?

optional onRemove(map: Map): void

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

Parameters

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

Returns

void

Defined in

src/source/source.ts:87

prepare()?

optional prepare(): void

Allows to execute a prepare step before the source is used.

Returns

void

Defined in

src/source/source.ts:118

serialize()

serialize(): any

Returns

any

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.