OpenLayers 3

ol.source. ol.source.XYZ

new XYZ

Stability: experimental
Parameters:
Name Type Description
options olx.source.XYZOptions

XYZ options.

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

Attributions.
crossOrigin null | string | undefined

Cross origin setting for image requests.
extent ol.Extent | undefined

Extent.
logo string | undefined

Logo.
projection ol.proj.ProjectionLike

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

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

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

Optional function to load a tile given a URL.
tileUrlFunction ol.TileUrlFunctionType | undefined

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

Whether to wrap the world horizontally. Default is true.
Source:
  • xyzsource.js, line 17

Extends

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