Module: ol/source/TileJSON




Type Definitions


Name Type Description
name string | undefined

The name.

description string | undefined

The description.

version string | undefined

The version.

attribution string | undefined

The attribution.

template string | undefined

The template.

legend string | undefined

The legend.

scheme string | undefined

The scheme.

tiles Array.<string>

The tile URL templates.

grids Array.<string> | undefined

Optional grids.

minzoom number | undefined

Minimum zoom level.

maxzoom number | undefined

Maximum zoom level.

bounds Array.<number> | undefined

Optional bounds.

center Array.<number> | undefined

Optional center.


Name Type Description
attributions AttributionLike | undefined


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

jsonp boolean
(defaults to false)

Use JSONP with callback to load the TileJSON. Useful when the server does not support CORS..

reprojectionErrorThreshold number
(defaults to 0.5)

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

tileJSON Config | undefined

TileJSON configuration for this source. If not provided, url must be configured.

tileLoadFunction LoadFunction | undefined

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

function(imageTile, src) {
  imageTile.getImage().src = src;
tileSize number | Size
(defaults to [256, 256])

The tile size used by the tile service. Note: tileSize and other non-standard TileJSON properties are currently ignored.

url string | undefined

URL to the TileJSON file. If not provided, tileJSON must be configured.

wrapX boolean
(defaults to true)

Whether to wrap the world horizontally.

transition number | undefined

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.