Classes
Type Definitions
-
Image tile loading function. The function is called with z, x, and y tile coordinates and returns an
imageor a promise for the same. -
Options{Object}
-
Properties:
Name Type Description urlUrlLike | undefined The image URL template. In addition to a single URL template, an array of URL templates or a function can be provided. If a function is provided, it will be called with z, x, y tile coordinates and loader options and should return a URL.
loaderLoader | undefined Data loader. Called with z, x, and y tile coordinates. Returns an
imagefor a tile or a promise for the same. The promise should not resolve until the image is loaded. If theurloption is provided, a loader will be created.attributionsAttributionLike | undefined Attributions.
attributionsCollapsibleboolean
(defaults to true)Attributions are collapsible.
maxZoomnumber
(defaults to 42)Optional max zoom level. Not used if
tileGridis provided.minZoomnumber
(defaults to 0)Optional min zoom level. Not used if
tileGridis provided.tileSizenumber | 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
tileGridis provided.gutternumber
(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.maxResolutionnumber | undefined Optional tile grid resolution at level zero. Not used if
tileGridis provided.projectionProjectionLike
(defaults to 'EPSG:3857')Tile projection.
tileGridTileGrid | undefined Tile grid.
stateState | undefined The source state.
wrapXboolean
(defaults to true)Render tiles beyond the antimeridian.
transitionnumber | undefined Transition time when fading in new tiles (in miliseconds).
interpolateboolean
(defaults to true)Use interpolated values when resampling.
crossOriginCrossOriginAttribute
(defaults to 'anonymous')The crossOrigin property to pass to loaders for image data.
-
-
UrlLike{string} {Array.<string>} {UrlGetter}
-