RasterTileSource
A source containing raster tiles (See the Style Specification for detailed documentation of options.)
Example
map.addSource('raster-source', {
'type': 'raster',
'tiles': ['https://tiles.stadiamaps.com/tiles/stamen_watercolor/{z}/{x}/{y}.jpg'],
'tileSize': 256,
});
Example
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
Implements
Methods
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
Source
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. |
Returns
Inherited from
Source
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
Source
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
Source
setEventedParent()
setEventedParent(
parent
?:Evented
,data
?:any
):RasterTileSource
Bubble all events fired by this instance of Evented to this parent instance of Evented.
Parameters
Parameter | Type |
---|---|
parent ? |
Evented |
data ? |
any |
Returns
Inherited from
Source
setTiles()
setTiles(
tiles
:string
[]):this
Sets the source tiles
property and re-renders the map.
Parameters
Parameter | Type | Description |
---|---|---|
tiles |
string [] |
An array of one or more tile source URLs, as in the raster tiles spec (See the Style Specification |
Returns
this
Source
src/source/raster_tile_source.ts:144
setUrl()
setUrl(
url
:string
):this
Sets the source url
property and re-renders the map.
Parameters
Parameter | Type | Description |
---|---|---|
url |
string |
A URL to a TileJSON resource. Supported protocols are http: and https: . |
Returns
this