RasterTileSource

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

Examples

map.addSource('raster-source', {
    'type': 'raster',
    'tiles': ['https://tiles.stadiamaps.com/tiles/stamen_watercolor/{z}/{x}/{y}.jpg'],
    'tileSize': 256,
});

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
});

See

Extends

Evented

Extended by

RasterDEMTileSource

Implements

Source

Methods

abortTile()

abortTile(tile: Tile): Promise<void>

Allows to abort a tile loading.

Parameters

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

Returns

Promise<void>

Implementation of

Source.abortTile

Defined in

src/source/raster_tile_source.ts:211

hasTile()

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

Implementation of

Source.hasTile

Defined in

src/source/raster_tile_source.ts:170

hasTransition()

hasTransition(): boolean

True if the source has transition, false otherwise.

Returns

boolean

Implementation of

Source.hasTransition

Defined in

src/source/raster_tile_source.ts:224

listens()

listens(type: string): boolean

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

Defined in

src/util/evented.ts:161

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>

Implementation of

Source.loadTile

Defined in

src/source/raster_tile_source.ts:174

loaded()

loaded(): boolean

True if the source is loaded, false otherwise.

Returns

boolean

Implementation of

Source.loaded

Defined in

src/source/raster_tile_source.ts:112

off()

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

Removes a previously registered event listener.

Parameters

Parameter	Type	Description
`type`	`string`	The event type to remove listeners for.
`listener`	`Listener`	The listener function to remove.

on()

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

Adds a listener to a specified event type.

Parameters

Parameter	Type	Description
`type`	`string`	The event type to add a listen for.
`listener`	`Listener`	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

this

Inherited from

Evented.on

Defined in

src/util/evented.ts:73

onAdd()

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

Implementation of

Source.onAdd

Defined in

src/source/raster_tile_source.ts:116

onRemove()

onRemove(): void

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

Returns

void

Implementation of

Source.onRemove

Defined in

src/source/raster_tile_source.ts:121

once()

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

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

Parameter	Type	Description
`type`	`string`	The event type to listen for.
`listener`?	`Listener`	The 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

Defined in

src/util/evented.ts:102

serialize()

serialize(): RasterSourceSpecification | RasterDEMSourceSpecification

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.