OpenLayers 3 API Documentation

Class: XYZ

ol.source.XYZ

Layer source for tile data with URLs in a set XYZ format.

new ol.source.XYZ(options)

src/ol/source/xyzsource.js, line 19
Name Type Description
options

XYZ options.

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

Attributions.
crossOrigin null | string | undefined

Cross origin setting for image requests.
logo string | olx.LogoOptions | undefined

Logo.
projection ol.proj.ProjectionLike experimental

Projection. Default is EPSG:3857.
maxZoom number | undefined experimental

Optional max zoom level. Default is 18.
minZoom number | undefined experimental

Unsupported (TODO: remove this).
tileLoadFunction ol.TileLoadFunctionType | undefined experimental

Optional function to load a tile given a URL.
tilePixelRatio number | undefined experimental

The pixel ratio used by the tile service. For example, if the tile service advertizes 256px by 256px tiles but actually sends 512px by 512px images (for retina/hidpi devices) then tilePixelRatio should be set to 2. Default is 1.
tileUrlFunction ol.TileUrlFunctionType | undefined experimental

Optional function to get tile URL given a tile coordinate and the projection. Required if url or urls are not provided.
url string | undefined

URL template. Must include {x}, {y} or {-y}, and {z} placeholders.
urls Array.<string> | undefined

An array of URL templates.
wrapX boolean | undefined experimental

Whether to wrap the world horizontally. Default is true.
Fires:
  • change - Triggered when the state of the source changes.

Subclasses

Extends

Methods

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:
  • change experimental

getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 96
Returns:
Attributions.
src/ol/source/source.js, line 105
Returns:
Logo.

getProjection(){ol.proj.Projection} inherited experimental

src/ol/source/source.js, line 114
Returns:
Projection.

getRevision(){number} inherited experimental

src/ol/observable.js, line 52
Returns:
Revision.

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

src/ol/source/source.js, line 129
Returns:
State.

getTileGrid(){ol.tilegrid.TileGrid} inherited

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

getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental

src/ol/source/tileimagesource.js, line 131
Returns:
TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental

src/ol/source/tileimagesource.js, line 140
Returns:
TileUrlFunction

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

src/ol/observable.js, line 65

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 78

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

src/ol/source/tileimagesource.js, line 149
Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction) experimental

src/ol/source/xyzsource.js, line 63
Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.

setUrl(url)

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

URL.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

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 101

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

Name Type Description
key goog.events.Key

Key.