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>	2048	Cache size.
`crossOrigin`	null \| string	<optional>		The `crossOrigin` attribute for loaded images. Note that you must provide a `crossOrigin` value if you are using the WebGL renderer or 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.
`opaque`	boolean	<optional>	true	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>	18	Optional max zoom level.
`minZoom`	number	<optional>	0	Optional min zoom level.
`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.
`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>		Duration of the opacity transition for rendering. To disable the opacity transition, pass `transition: 0`.