Class: XYZ

ol/source/XYZ~XYZ 


import XYZ from 'ol/source/XYZ.js';

Layer source for tile data with URLs in a set XYZ format that are defined in a URL template. By default, this follows the widely-used Google grid where x 0 and y 0 are in the top left. Grids like TMS where x 0 and y 0 are in the bottom left can be used by using the {-y} placeholder in the URL template, so long as the source does not have a custom tile grid. In this case a tileUrlFunction can be used, such as:

 tileUrlFunction: function(coordinate) {
   return 'http://mapserver.com/' + coordinate[0] + '/' +
     coordinate[1] + '/' + (-coordinate[2] - 1) + '.png';
 }

new XYZ(options)

source/XYZ.js, line 73
Name Type Description
attributions AttributionLike | undefined

Attributions.
attributionsCollapsible boolean (defaults to true)

Attributions are collapsible.
cacheSize number | undefined

Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
crossOrigin null | string | undefined

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
interpolate boolean (defaults to true)

Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
opaque boolean (defaults to false)

Whether the layer is opaque.
projection ProjectionLike (defaults to 'EPSG:3857')

Projection.
reprojectionErrorThreshold number (defaults to 0.5)

Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
maxZoom number (defaults to 42)

Optional max zoom level. Not used if tileGrid is provided.
minZoom number (defaults to 0)

Optional min zoom level. Not used if tileGrid is provided.
maxResolution number | undefined

Optional tile grid resolution at level zero. Not used if tileGrid is provided.
tileGrid TileGrid | undefined

Tile grid.
tileLoadFunction LoadFunction | undefined

Optional function to load a tile given a URL. The default is

function(imageTile, src) {
  imageTile.getImage().src = src;
};
tilePixelRatio number (defaults to 1)

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.
tileSize number | Size (defaults to [256, 256])

The tile size used by the tile service. Not used if tileGrid is provided.
gutter number (defaults to 0)

The size in pixels of the gutter around image tiles to ignore. This allows artifacts of rendering at tile edges to be ignored. Supported images should be wider and taller than the tile size by a value of 2 x gutter.
tileUrlFunction UrlFunction | 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. A {?-?} template pattern, for example subdomain{a-f}.domain.com, may be used instead of defining each one separately in the urls option.
urls Array.<string> | undefined

An array of URL templates.
wrapX boolean (defaults to true)

Whether to wrap the world horizontally.
transition number (defaults to 250)

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.
zDirection number | NearestDirectionFunction (defaults to 0)

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.
Fires:

Subclasses

Extends

Methods

changed() inherited

Observable.js, line 68

Increases the revision counter and dispatches a 'change' event.

clear() inherited

source/Tile.js, line 344

Remove all cached tiles from the source. The next render cycle will fetch new tiles.

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getAttributions(){Attribution} inherited

source/Source.js, line 132

Get the attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 140
Returns:
Attributions are collapsible.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

getProjection(){Projection | null} inherited

source/Source.js, line 149

Get the projection of the source.

Returns:
Projection.

getProperties(){Object.<string, *>} inherited

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 79

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

getState(){State} inherited

source/Source.js, line 173

Get the state of the source, see State for possible states.

Returns:
State.

getTileGrid(){TileGrid | null} inherited

source/Tile.js, line 266

Return the tile grid of the tile source.

Returns:
Tile grid.

getTileLoadFunction(){LoadFunction} inherited

source/UrlTile.js, line 101

Return the tile load function of the source.

Returns:
TileLoadFunction

getTileUrlFunction(){UrlFunction} inherited

source/UrlTile.js, line 110

Return the tile URL function of the source.

Returns:
TileUrlFunction

getUrls(){!Array.<string> | null} inherited

source/UrlTile.js, line 123

Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

Returns:
URLs.

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

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.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

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.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

refresh() inherited

source/Source.js, line 195

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, silent) inherited

Object.js, line 207

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean | undefined

Update without triggering an event.

setAttributions(attributions) inherited

source/Source.js, line 206

Set the attributions of the source.

Name Type Description
attributions AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, Attribution, or undefined.

setProperties(values, silent) inherited

Object.js, line 227

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.
silent boolean | undefined

Update without triggering an event.

setRenderReprojectionEdges(render) inherited

source/TileImage.js, line 393

Sets whether to render reprojection edges or not (usually for debugging).

Name Type Description
render boolean

Render the edges.

setTileGridForProjection(projection, tilegrid) inherited

source/TileImage.js, line 416

Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

Name Type Description
projection ProjectionLike

Projection.
tilegrid TileGrid

Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited

source/UrlTile.js, line 159

Set the tile load function of the source.

Name Type Description
tileLoadFunction LoadFunction

Tile load function.

setTileUrlFunction(tileUrlFunction, key) inherited

source/UrlTile.js, line 171

Set the tile URL function of the source.

Name Type Description
tileUrlFunction UrlFunction

Tile URL function.
key string | undefined

Optional new tile key for the source.

setUrl(url) inherited

source/UrlTile.js, line 186

Set the URL to use for requests.

Name Type Description
url string

URL.

setUrls(urls) inherited

source/UrlTile.js, line 197

Set the URLs to use for requests.

Name Type Description
urls Array.<string>

URLs.

un(type, listener) inherited

Observable.js, line 173

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.

unset(key, silent) inherited

Object.js, line 251

Unsets a property.

Name Type Description
key string

Key name.
silent boolean | undefined

Unset without triggering an event.