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

RasterTileSource ​

Defined in: src/source/raster_tile_source.ts:52

A source containing raster tiles (See the raster source documentation for detailed documentation of options.)

Examples ​

ts
map.addSource('raster-source', {
    'type': 'raster',
    'tiles': ['https://tiles.stadiamaps.com/tiles/stamen_watercolor/{z}/{x}/{y}.jpg'],
    'tileSize': 256, // Set this to match tile server output to avoid blurry rendering
});
ts
map.addSource('wms-test-source', {
     'type': 'raster',
// use the tiles option to specify a WMS tile source URL
     'tiles': [
         'https://img.nj.gov/imagerywms/Natural2015?bbox={bbox-epsg-3857}&format=image/png&service=WMS&version=1.1.1&request=GetMap&srs=EPSG:3857&transparent=true&width=256&height=256&layers=Natural2015'
     ],
     'tileSize': 256 // Important for WMS if tiles are 256px
});

See ​

Extends ​

Extended by ​

Implements ​

Methods ​

abortTile() ​

abortTile(tile: Tile): Promise<void>

Defined in: src/source/raster_tile_source.ts:213

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/raster_tile_source.ts:172

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/raster_tile_source.ts:226

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/raster_tile_source.ts:114

True if the source is loaded, false otherwise.

Returns ​

boolean

Implementation of ​

Source.loaded

loadTile() ​

loadTile(tile: Tile): Promise<void>

Defined in: src/source/raster_tile_source.ts:176

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): RasterTileSource

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 ​

RasterTileSource

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/raster_tile_source.ts:118

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> | RasterTileSource

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> | RasterTileSource

this or a promise if a listener is not provided

Inherited from ​

Evented.once

onRemove() ​

onRemove(): void

Defined in: src/source/raster_tile_source.ts:123

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

Returns ​

void

Implementation of ​

Source.onRemove

serialize() ​

serialize(): RasterSourceSpecification | RasterDEMSourceSpecification

Defined in: src/source/raster_tile_source.ts:168

Returns ​

RasterSourceSpecification | RasterDEMSourceSpecification

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): RasterTileSource

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 ​

RasterTileSource

Inherited from ​

Evented.setEventedParent

setTiles() ​

setTiles(tiles: string[]): this

Defined in: src/source/raster_tile_source.ts:146

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 raster tiles spec (See the Style Specification

Returns ​

this

setUrl() ​

setUrl(url: string): this

Defined in: src/source/raster_tile_source.ts:159

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/raster_tile_source.ts:220

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/raster_tile_source.ts:54

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

Implementation of ​

Source.id

maxzoom ​

maxzoom: number

Defined in: src/source/raster_tile_source.ts:56

The maximum zoom level for the source.

Implementation of ​

Source.maxzoom

minzoom ​

minzoom: number

Defined in: src/source/raster_tile_source.ts:55

The minimum zoom level for the source.

Implementation of ​

Source.minzoom

roundZoom ​

roundZoom: boolean

Defined in: src/source/raster_tile_source.ts:63

true if zoom levels are rounded to the nearest integer in the source data, false if they are floor-ed to the nearest integer.

Implementation of ​

Source.roundZoom

tileSize ​

tileSize: number

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

The tile size for the source.

Implementation of ​

Source.tileSize