Module: ol/source/XYZ

ol/source/XYZ


Classes

XYZ

Type Definitions

Options{Object}

Properties:
Name Type Argument Default Description
attributions module:ol/source/Source~AttributionLike <optional>

Attributions.

attributionsCollapsible boolean <optional>
true

Attributions are collapsible.

cacheSize number <optional>

Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.

crossOrigin null | string <optional>

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.

imageSmoothing boolean <optional>
true

Enable image smoothing.

opaque boolean <optional>
false

Whether the layer is opaque.

projection module:ol/proj~ProjectionLike <optional>
'EPSG:3857'

Projection.

reprojectionErrorThreshold number <optional>
0.5

Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.

maxZoom number <optional>
42

Optional max zoom level. Not used if tileGrid is provided.

minZoom number <optional>
0

Optional min zoom level. Not used if tileGrid is provided.

maxResolution number <optional>

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

tileGrid module:ol/tilegrid/TileGrid~TileGrid <optional>

Tile grid.

tileLoadFunction module:ol/Tile~LoadFunction <optional>

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

function(imageTile, src) {
  imageTile.getImage().src = src;
};
tilePixelRatio number <optional>
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 | module:ol/size~Size <optional>
[256, 256]

The tile size used by the tile service. Not used if tileGrid is provided.

tileUrlFunction module:ol/Tile~UrlFunction <optional>

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

url string <optional>

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

An array of URL templates.

wrapX boolean <optional>
true

Whether to wrap the world horizontally.

transition number <optional>
250

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.

zDirection number | module:ol/array~NearestDirectionFunction <optional>
0

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See module:ol/tilegrid/TileGrid~TileGrid#getZForResolution.