Class: OSM

ol.source.OSM

Layer source for the OpenStreetMap tile server.

new ol.source.OSM(opt_options)

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.

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.

Fires:
  • change - Triggered when the state of the source changes.

Extends

Members

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

Methods

changed() inherited experimental

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

Fires:
  • change experimental
Returns:
Attributions.
Returns:
Logo.
Returns:
Projection.

getRevision(){number} inherited experimental

Returns:
Revision.
Returns:
State.
Returns:
Tile grid.
Returns:
TileLoadFunction
Returns:
TileUrlFunction

on(type, listener, opt_this){goog.events.Key} inherited

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

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.

setTileLoadFunction(tileLoadFunction) inherited experimental

Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction) inherited experimental

Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.

Name Type Description
url string

URL.

un(type, listener, opt_this) inherited

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.

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().