Source
Defined in: src/source/source.ts:30
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()?
optionalabortTile(tile:Tile):Promise<void>
Defined in: src/source/source.ts:104
Allows to abort a tile loading.
Parameters
| Parameter | Type | Description |
|---|---|---|
tile |
Tile |
The tile to abort |
Returns
Promise<void>
fire()
fire(
event:Event):unknown
Defined in: src/source/source.ts:78
An ability to fire an event to all the listeners, see Evented
Parameters
| Parameter | Type | Description |
|---|---|---|
event |
Event |
The event to fire |
Returns
unknown
hasTile()?
optionalhasTile(tileID:OverscaledTileID):boolean
Defined in: src/source/source.ts:99
True is the tile is part of the source, false otherwise.
Parameters
| Parameter | Type | Description |
|---|---|---|
tileID |
OverscaledTileID |
The tile ID |
Returns
boolean
hasTransition()
hasTransition():
boolean
Defined in: src/source/source.ts:69
True if the source has transition, false otherwise.
Returns
boolean
loaded()
loaded():
boolean
Defined in: src/source/source.ts:73
True if the source is loaded, false otherwise.
Returns
boolean
loadTile()
loadTile(
tile:Tile):Promise<void>
Defined in: src/source/source.ts:94
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>
onAdd()?
optionalonAdd(map:Map):void
Defined in: src/source/source.ts:83
This method is called when the source is added to the map.
Parameters
| Parameter | Type | Description |
|---|---|---|
map |
Map |
The map instance |
Returns
void
onRemove()?
optionalonRemove(map:Map):void
Defined in: src/source/source.ts:88
This method is called when the source is removed from the map.
Parameters
| Parameter | Type | Description |
|---|---|---|
map |
Map |
The map instance |
Returns
void
prepare()?
optionalprepare():void
Defined in: src/source/source.ts:119
Allows to execute a prepare step before the source is used.
Returns
void
serialize()
serialize():
any
Defined in: src/source/source.ts:115
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.
unloadTile()?
optionalunloadTile(tile:Tile):Promise<void>
Defined in: src/source/source.ts:109
Allows to unload a tile.
Parameters
| Parameter | Type | Description |
|---|---|---|
tile |
Tile |
The tile to unload |
Returns
Promise<void>
Properties
attribution?
optionalattribution:string
Defined in: src/source/source.ts:51
The attribution for the source.
calculateTileZoom?
optionalcalculateTileZoom:CalculateTileZoomFunction
Defined in: src/source/source.ts:123
Optional function to redefine how tiles are loaded at high pitch angles.
id
id:
string
Defined in: src/source/source.ts:35
The id for the source. Must not be used by any existing source.
isTileClipped?
optionalisTileClipped:boolean
Defined in: src/source/source.ts:59
false if tiles can be drawn outside their boundaries, true if they cannot.
maxzoom
maxzoom:
number
Defined in: src/source/source.ts:43
The maximum zoom level for the source.
minzoom
minzoom:
number
Defined in: src/source/source.ts:39
The minimum zoom level for the source.
reparseOverscaled?
optionalreparseOverscaled:boolean
Defined in: src/source/source.ts:64
true if tiles should be sent back to the worker for each overzoomed zoom level, false if not.
roundZoom?
optionalroundZoom:boolean
Defined in: src/source/source.ts:55
true if zoom levels are rounded to the nearest integer in the source data, false if they are floor-ed to the nearest integer.
tileSize
tileSize:
number
Defined in: src/source/source.ts:47
The tile size for the source.