MapMetrics Atlas API Docs

Appearance

Both copy text to your clipboard — Build with AI copies a setup prompt to paste into Claude Code, Cursor, Codex or Copilot; Copy page as Markdown copies this page to paste into a chat. How it works

VectorTileSource ​

Defined in: src/source/vector_tile_source.ts:57

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

Examples ​

ts
map.addSource('some id', {
    type: 'vector',
    url: 'https://demotiles.mapmetrics.org/tiles/tiles.json'
});
ts
map.addSource('some id', {
    type: 'vector',
    tiles: ['https://d25uarhxywzl1j.cloudfront.net/v0.1/{z}/{x}/{y}.mvt'],
    minzoom: 6,
    maxzoom: 14
});
ts
map.getSource('some id').setUrl("https://demotiles.mapmetrics.org/tiles/tiles.json");
ts
map.getSource('some id').setTiles(['https://d25uarhxywzl1j.cloudfront.net/v0.1/{z}/{x}/{y}.mvt']);

See ​

Add a vector tile source

Extends ​

Implements ​

Methods ​

abortTile() ​

abortTile(tile: Tile): Promise<void>

Defined in: src/source/vector_tile_source.ts:256

Allows to abort a tile loading.

Parameters ​

ParameterTypeDescription
tileTileThe tile to abort

Returns ​

Promise<void>

Implementation of ​

Source.abortTile

hasTile() ​

hasTile(tileID: OverscaledTileID): boolean

Defined in: src/source/vector_tile_source.ts:134

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

Parameters ​

ParameterTypeDescription
tileIDOverscaledTileIDThe tile ID

Returns ​

boolean

Implementation of ​

Source.hasTile

hasTransition() ​

hasTransition(): boolean

Defined in: src/source/vector_tile_source.ts:282

True if the source has transition, false otherwise.

Returns ​

boolean

Implementation of ​

Source.hasTransition

listens() ​

listens(type: string): boolean

Defined in: src/util/evented.ts:165

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

Parameters ​

ParameterTypeDescription
typestringThe 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: src/source/vector_tile_source.ts:130

True if the source is loaded, false otherwise.

Returns ​

boolean

Implementation of ​

Source.loaded

loadTile() ​

loadTile(tile: Tile): Promise<void>

Defined in: src/source/vector_tile_source.ts:191

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

Parameters ​

ParameterTypeDescription
tileTileThe tile to load

Returns ​

Promise<void>

Implementation of ​

Source.loadTile

off() ​

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

Defined in: src/util/evented.ts:90

Removes a previously registered event listener.

Parameters ​

ParameterTypeDescription
typestringThe event type to remove listeners for.
listenerListenerThe listener function to remove.

Returns ​

VectorTileSource

Inherited from ​

Evented.off

on() ​

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

Defined in: src/util/evented.ts:73

Adds a listener to a specified event type.

Parameters ​

ParameterTypeDescription
typestringThe event type to add a listen for.
listenerListenerThe 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: src/source/vector_tile_source.ts:138

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

Parameters ​

ParameterTypeDescription
mapMapThe map instance

Returns ​

void

Implementation of ​

Source.onAdd

once() ​

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

Defined in: src/util/evented.ts:106

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 ​

ParameterTypeDescription
typestringThe event type to listen for.
listener?ListenerThe function to be called when the event is fired the first time.

Returns ​

Promise<any> | VectorTileSource

this or a promise if a listener is not provided

Inherited from ​

Evented.once

onRemove() ​

onRemove(): void

Defined in: src/source/vector_tile_source.ts:180

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

Returns ​

void

Implementation of ​

Source.onRemove

serialize() ​

serialize(): VectorSourceSpecification

Defined in: src/source/vector_tile_source.ts:187

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.

Implementation of ​

Source.serialize

setEventedParent() ​

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

Defined in: src/util/evented.ts:176

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

Parameters ​

ParameterType
parent?Evented
data?any

Returns ​

VectorTileSource

Inherited from ​

Evented.setEventedParent

setTiles() ​

setTiles(tiles: string[]): this

Defined in: src/source/vector_tile_source.ts:158

Sets the source tiles property and re-renders the map.

Parameters ​

ParameterTypeDescription
tilesstring[]An array of one or more tile source URLs, as in the TileJSON spec.

Returns ​

this

setUrl() ​

setUrl(url: string): this

Defined in: src/source/vector_tile_source.ts:171

Sets the source url property and re-renders the map.

Parameters ​

ParameterTypeDescription
urlstringA URL to a TileJSON resource. Supported protocols are http: and https:.

Returns ​

this

unloadTile() ​

unloadTile(tile: Tile): Promise<void>

Defined in: src/source/vector_tile_source.ts:269

Allows to unload a tile.

Parameters ​

ParameterTypeDescription
tileTileThe tile to unload

Returns ​

Promise<void>

Implementation of ​

Source.unloadTile

Properties ​

id ​

id: string

Defined in: src/source/vector_tile_source.ts:59

The id for the source. Must not be used by any existing source.

Implementation of ​

Source.id

isTileClipped ​

isTileClipped: boolean

Defined in: src/source/vector_tile_source.ts:75

false if tiles can be drawn outside their boundaries, true if they cannot.

Implementation of ​

Source.isTileClipped

maxzoom ​

maxzoom: number

Defined in: src/source/vector_tile_source.ts:61

The maximum zoom level for the source.

Implementation of ​

Source.maxzoom

minzoom ​

minzoom: number

Defined in: src/source/vector_tile_source.ts:60

The minimum zoom level for the source.

Implementation of ​

Source.minzoom

reparseOverscaled ​

reparseOverscaled: boolean

Defined in: src/source/vector_tile_source.ts:74

true if tiles should be sent back to the worker for each overzoomed zoom level, false if not.

Implementation of ​

Source.reparseOverscaled

tileSize ​

tileSize: number

Defined in: src/source/vector_tile_source.ts:64

The tile size for the source.

Implementation of ​

Source.tileSize