Module: ol/source/DataTile

Classes

DataTileSource

Type Definitions

CrossOriginAttribute{'anonymous'} {'use-credentials'}

Loader()

source/DataTile.js, line 34

Data tile loading function. The function is called with z, x, and y tile coordinates and returns data for a tile or a promise for the same.

LoaderOptions{Object}

Properties:

Name	Type	Description
signal	AbortSignal	An abort controller signal.
crossOrigin	CrossOriginAttribute | undefined	The cross-origin attribute for images.
maxY	number | undefined	The maximum y coordinate at the given z level. Will be undefined if the underlying tile grid does not have a known extent.

Options{Object}

Properties:

Name	Type	Description
loader	Loader | undefined	Data loader. Called with z, x, and y tile coordinates. Returns data for a tile or a promise for the same. For loaders that generate images, the promise should not resolve until the image is loaded.
attributions	AttributionLike | undefined	Attributions.
attributionsCollapsible	boolean (defaults to true)	Attributions are collapsible.
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.
tileSize	number | Size (defaults to [256, 256])	The pixel width and height of the source tiles. This may be different than the rendered pixel size if a tileGrid is provided.
gutter	number (defaults to 0)	The size in pixels of the gutter around data tiles to ignore. This allows artifacts of rendering at tile edges to be ignored. Supported data should be wider and taller than the tile size by a value of 2 x gutter.
maxResolution	number | undefined	Optional tile grid resolution at level zero. Not used if tileGrid is provided.
projection	ProjectionLike (defaults to 'EPSG:3857')	Tile projection.
tileGrid	TileGrid | undefined	Tile grid.
state	State | undefined	The source state.
wrapX	boolean (defaults to false)	Render tiles beyond the antimeridian.
transition	number | undefined	Transition time when fading in new tiles (in milliseconds).
bandCount	number (defaults to 4)	Number of bands represented in the data.
interpolate	boolean (defaults to false)	Use interpolated values when resampling. By default, the nearest neighbor is used when resampling.
crossOrigin	CrossOriginAttribute (defaults to 'anonymous')	The crossOrigin property to pass to loaders for image data.
key	string | undefined	Key for use in caching tiles.