OpenLayers 3 API Reference

Class: OSM

ol .source.OSM

Layer source for the OpenStreetMap tile server.

new ol.source.OSM(opt_options)

src/ol/source/osmsource.js, line 17

Name Type Description

options

Open Street Map options.

Name	Type	Description
`attributions`	Array.<ol.Attribution> \| undefined	Attributions.
`crossOrigin`	null \| string \| undefined	The `crossOrigin` attribute for loaded images. Note that you must provide a `crossOrigin` value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. Default is `anonymous`.
`maxZoom`	number \| undefined	experimental Max zoom. Default is `19`.
`reprojectionErrorThreshold`	number \| undefined	experimental Maximum allowed reprojection error (in pixels). Default is `0.5`. Higher values can increase reprojection performance, but decrease precision.
`tileLoadFunction`	ol.TileLoadFunctionType \| undefined	experimental Optional function to load a tile given a URL.
`url`	string \| undefined	URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders. Default is `//{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png`.
`wrapX`	boolean \| undefined	experimental Whether to wrap the world horizontally. Default is `true`.

Fires:

change experimental - Triggered when the revision counter is increased.
propertychange (ol.ObjectEvent) - Triggered when a property is changed.
tileloadend (ol.source.TileEvent) - Triggered when a tile finishes loading.
tileloaderror (ol.source.TileEvent) - Triggered if tile loading results in an error.
tileloadstart (ol.source.TileEvent) - Triggered when a tile starts loading.

Extends

ol.source.XYZ

Members

ol.source.OSM.ATTRIBUTION{ol.Attribution} experimental

The attribution containing a link to the OpenStreetMap Copyright and License page.

Methods

changed() inherited experimental src/ol/observable.js, line 51

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

dispatchEvent(event) inherited experimental src/ol/observable.js, line 73

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`	goog.events.EventLike	Event object.

get(key){*} inherited src/ol/object.js, line 149

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getAttributions(){Array.<ol.Attribution>} inherited src/ol/source/source.js, line 105

Get the attributions of the source.

Returns:

Attributions.

getKeys(){Array.<string>} inherited src/ol/object.js, line 163

Get a list of object property names.

Returns:

List of property names.

getLogo(){string|olx.LogoOptions|undefined} inherited src/ol/source/source.js, line 115

Get the logo of the source.

Returns:

Logo.

getProjection(){ol.proj.Projection} inherited experimental src/ol/source/source.js, line 125

Get the projection of the source.

Returns:

Projection.

getProperties(){Object.<string, *>} inherited src/ol/object.js, line 173

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited experimental src/ol/observable.js, line 82

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

Returns:

Revision.

getState(){ol.source.State} inherited experimental src/ol/source/source.js, line 141

Get the state of the source, see ol.source.State for possible states.

Returns:

State.

getTileGrid(){ol.tilegrid.TileGrid} inherited src/ol/source/tilesource.js, line 201

Return the tile grid of the tile source.

Returns:

Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental src/ol/source/urltilesource.js, line 99

Return the tile load function of the source.

Returns:

TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental src/ol/source/urltilesource.js, line 109

Return the tile URL function of the source.

Returns:

TileUrlFunction

getUrls(){!Array.<string>|null} inherited experimental src/ol/source/urltilesource.js, line 121

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, opt_this){goog.events.Key} inherited src/ol/observable.js, line 95

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.
`this`	Object	The object to use as `this` in `listener`.

Returns:

Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited src/ol/observable.js, line 108

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.
`this`	Object	The object to use as `this` in `listener`.

Returns:

Unique key for the listener.

set(key, value, opt_silent) inherited src/ol/object.js, line 203

Sets a value.

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

setAttributions(attributions) inherited experimental src/ol/source/source.js, line 159

Set the attributions of the source.

Name	Type	Description
`attributions`	Array.<ol.Attribution>	Attributions.

setProperties(values, opt_silent) inherited src/ol/object.js, line 221

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 experimental src/ol/source/tileimagesource.js, line 241

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

Name	Type	Description
`render`	boolean	Render the edges.

setTileGridForProjection(projection, tilegrid) inherited experimental src/ol/source/tileimagesource.js, line 266

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`	ol.proj.ProjectionLike	Projection.
`tilegrid`	ol.tilegrid.TileGrid	Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited experimental src/ol/source/urltilesource.js, line 155

Set the tile load function of the source.

Name	Type	Description
`tileLoadFunction`	ol.TileLoadFunctionType	Tile load function.

setTileUrlFunction(tileUrlFunction) inherited experimental src/ol/source/urltilesource.js, line 167

Set the tile URL function of the source.

Name	Type	Description
`tileUrlFunction`	ol.TileUrlFunctionType	Tile URL function.

setUrl(url) inherited src/ol/source/urltilesource.js, line 182

Set the URL to use for requests.

Name	Type	Description
`url`	string	URL.

setUrls(urls) inherited src/ol/source/urltilesource.js, line 194

Set the URLs to use for requests.

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

un(type, listener, opt_this) inherited src/ol/observable.js, line 121

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.
`this`	Object	The object which was used as `this` by the `listener`.

unByKey(key) inherited src/ol/observable.js, line 134

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name	Type	Description
`key`	goog.events.Key	The key returned by `on()` or `once()`.

unset(key, opt_silent) inherited src/ol/object.js, line 235

Unsets a property.

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