OpenLayers 3 API Documentation

Class: OSM

ol.source. OSM

experimental new ol.source.OSM(opt_options)

src/ol/source/osmsource.js, line 15
Name Type Argument Description
options optional

Open Street Map options.

Name Type Description
attributions Array.<ol.Attribution> | undefined

Attributions.
crossOrigin null | string | undefined

crossOrigin setting for image requests. Default is anonymous.
maxZoom number | undefined

Max zoom.
tileLoadFunction ol.TileLoadFunctionType | undefined

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

Extends

Members

experimental static,constantol.source.OSM.DATA_ATTRIBUTIONol.Attribution

experimental static,constantol.source.OSM.TILE_ATTRIBUTIONol.Attribution

Methods

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:
  • change

experimental inherited getState(){ol.source.State}

src/ol/source/source.js, line 137

experimental inherited getTileGrid(){ol.tilegrid.TileGrid}

src/ol/source/tilesource.js, line 157
Returns:
grid.

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

src/ol/observable.js, line 61

Listen for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

The object to use as this in listener.
Returns:
key for the listener.

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

src/ol/observable.js, line 74

Listen once for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

The object to use as this in listener.
Returns:
key for the listener.

experimental inherited setUrl(url)

src/ol/source/xyzsource.js, line 74
Name Type Description
url string

URL.

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

Unlisten for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

The object to use as this in listener.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.