OpenLayers 3

ol.source. ol.source.OSM

new OSM

Stability: experimental
Parameters:
Name Type Argument Description
options olx.source.OSMOptions <optional>

Open Street Map options.

Properties
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.
Source:
  • osmsource.js, line 15

Extends

Members

<static, constant> DATA_ATTRIBUTION :ol.Attribution

Stability: experimental
Source:
  • osmsource.js, line 51

<static, constant> TILE_ATTRIBUTION :ol.Attribution

Stability: experimental
Source:
  • osmsource.js, line 64

Methods

dispatchChangeEvent

Stability: experimental

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

Inherited From:
Source:
  • observable.js, line 39
Fires:
  • event:change

getState

Stability: experimental
Inherited From:
Source:
  • source.js, line 134
Returns:

State.

Type
ol.source.State

getTileGrid

Stability: experimental
Inherited From:
Source:
  • tilesource.js, line 187
Returns:

Tile grid.

Type
ol.tilegrid.TileGrid

on

Stability: experimental

Listen for a certain type of event.

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

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Inherited From:
Source:
  • observable.js, line 61
Returns:

Unique key for the listener.

Type
goog.events.Key

once

Stability: experimental

Listen once for a certain type of event.

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

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Inherited From:
Source:
  • observable.js, line 74
Returns:

Unique key for the listener.

Type
goog.events.Key

setUrl

Stability: experimental
Parameters:
Name Type Description
url string

URL.
Inherited From:
Source:
  • xyzsource.js, line 74

un

Stability: experimental

Unlisten for a certain type of event.

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

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Inherited From:
Source:
  • observable.js, line 86

unByKey

Stability: experimental

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

Parameters:
Name Type Description
key goog.events.Key

Key.
Inherited From:
Source:
  • observable.js, line 96