OpenLayers v6.1.1 API - Class: Stamen

Class: Stamen

ol/source/Stamen~Stamen

import Stamen from 'ol/source/Stamen';

Layer source for the Stamen tile server.

new Stamen(options)

source/Stamen.js, line 122

Name Type Description

options

Stamen options.

Name	Type	Description
`cacheSize`	number	Tile cache size. The default depends on the screen size. Will increase if too small.
`layer`	string	Layer name.
`minZoom`	number	Minimum zoom.
`maxZoom`	number	Maximum zoom.
`reprojectionErrorThreshold`	number (defaults to 0.5)	Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
`tileLoadFunction`	module:ol/Tile~LoadFunction	Optional function to load a tile given a URL. The default is `function(imageTile, src) { imageTile.getImage().src = src; };`
`transition`	number	Duration of the opacity transition for rendering. To disable the opacity transition, pass `transition: 0`.
`url`	string	URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
`wrapX`	boolean (defaults to true)	Whether to wrap the world horizontally.

Fires:

change (module:ol/events/Event~BaseEvent) - Generic change event. Triggered when the revision counter is increased.
error (module:ol/events/Event~BaseEvent) - Generic error event. Triggered when an error occurs.
propertychange (module:ol/Object.ObjectEvent) - Triggered when a property is changed.
tileloadend (module:ol/source/Tile.TileSourceEvent) - Triggered when a tile finishes loading, either when its data is loaded, or when loading was aborted because the tile is no longer needed.
tileloaderror (module:ol/source/Tile.TileSourceEvent) - Triggered if tile loading results in an error.
tileloadstart (module:ol/source/Tile.TileSourceEvent) - Triggered when a tile starts loading.

Extends

module:ol/source/XYZ~XYZ

Methods

changed() inherited Observable.js, line 36

Increases the revision counter and dispatches a 'change' event.

clear() inherited source/Tile.js, line 316

Remove all cached tiles from the source. The next render cycle will fetch new tiles.

dispatchEvent(event){boolean|undefined} inherited events/Target.js, line 96

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
`event`	Object \| module:ol/events/Event~BaseEvent \| string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited Object.js, line 119

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getKeys(){Array.<string>} inherited Object.js, line 132

Get a list of object property names.

Returns:

List of property names.

getProjection(){module:ol/proj/Projection~Projection} inherited source/Source.js, line 119

Get the projection of the source.

Returns:

Projection.

getProperties(){Object.<string, *>} inherited Object.js, line 141

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited Observable.js, line 47

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getState(){module:ol/source/State} inherited source/Source.js, line 136

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:

State.

getTileGrid(){module:ol/tilegrid/TileGrid~TileGrid} inherited source/Tile.js, line 235

Return the tile grid of the tile source.

Returns:

Tile grid.

getTileLoadFunction(){module:ol/Tile~LoadFunction} inherited source/UrlTile.js, line 102

Return the tile load function of the source.

Returns:

TileLoadFunction

getTileUrlFunction(){module:ol/Tile~UrlFunction} inherited source/UrlTile.js, line 111

Return the tile URL function of the source.

Returns:

TileUrlFunction

getUrls(){!Array.<string>|null} inherited source/UrlTile.js, line 122

Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

Returns:

URLs.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 60

Listen for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 82

Listen once for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited Object.js, line 164

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.
`silent`	boolean	Update without triggering an event.

setAttributions(attributions) inherited source/Source.js, line 162

Set the attributions of the source.

Name	Type	Description
`attributions`	module:ol/source/Source~AttributionLike \| undefined	Attributions. Can be passed as `string`, `Array<string>`, `module:ol/source/Source~Attribution`, or `undefined`.

setProperties(values, opt_silent) inherited Object.js, line 183

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
`values`	Object.<string, *>	Values.
`silent`	boolean	Update without triggering an event.

setRenderReprojectionEdges(render) inherited source/TileImage.js, line 358

Sets whether to render reprojection edges or not (usually for debugging).

Name	Type	Description
`render`	boolean	Render the edges.

setTileGridForProjection(projection, tilegrid) inherited source/TileImage.js, line 382

Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

Name	Type	Description
`projection`	module:ol/proj~ProjectionLike	Projection.
`tilegrid`	module:ol/tilegrid/TileGrid~TileGrid	Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited source/UrlTile.js, line 155

Set the tile load function of the source.

Name	Type	Description
`tileLoadFunction`	module:ol/Tile~LoadFunction	Tile load function.

setTileUrlFunction(tileUrlFunction, key) inherited source/UrlTile.js, line 167

Set the tile URL function of the source.

Name	Type	Description
`tileUrlFunction`	module:ol/Tile~UrlFunction	Tile URL function.
`key`	string	Optional new tile key for the source.

setUrl(url) inherited source/UrlTile.js, line 182

Set the URL to use for requests.

Name	Type	Description
`url`	string	URL.

setUrls(urls) inherited source/UrlTile.js, line 193

Set the URLs to use for requests.

Name	Type	Description
`urls`	Array.<string>	URLs.

un(type, listener) inherited Observable.js, line 101

Unlisten for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

unset(key, opt_silent) inherited Object.js, line 195

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean	Unset without triggering an event.