Class: XYZ

ol.source. XYZ

experimental new ol.source.XYZ(options)

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.

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.

Fires:
  • change

Subclasses

Extends

Methods

experimental inherited dispatchChangeEvent()

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

Fires:
  • change
Returns:
grid.

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

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}

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 setUrl(url)

Name Type Description
url string

URL.

experimental inherited un(type, listener, opt_this)

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)

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

Name Type Description
key goog.events.Key

Key.