Classes
Type Definitions
-
Options{Object}
-
Properties:
Name Type Argument Default Description attributions
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 acrossOrigin
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.interpolate
boolean <optional>
true Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
opaque
boolean <optional>
false Whether the layer is opaque.
projection
ProjectionLike <optional>
Projection. Default is the view projection.
reprojectionErrorThreshold
number <optional>
0.5 Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
state
State <optional>
Source state.
tileClass
Class<ImageTile> <optional>
Class used to instantiate image tiles. Default is
ImageTile
.tileGrid
TileGrid <optional>
Tile grid.
tileLoadFunction
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 to2
.tileUrlFunction
UrlFunction <optional>
Optional function to get tile URL given a tile coordinate and the projection.
url
string <optional>
URL template. Must include
{x}
,{y}
or{-y}
, and{z}
placeholders. A{?-?}
template pattern, for examplesubdomain{a-f}.domain.com
, may be used instead of defining each one separately in theurls
option.urls
Array.<string> <optional>
An array of URL templates.
wrapX
boolean <optional>
Whether to wrap the world horizontally. The default, is to request out-of-bounds tiles from the server. When set to
false
, only one world will be rendered. When set totrue
, tiles will be requested for one world only, but they will be wrapped horizontally to render multiple worlds.transition
number <optional>
Duration of the opacity transition for rendering. To disable the opacity transition, pass
transition: 0
.key
string <optional>
Optional tile key for proper cache fetching
zDirection
number | NearestDirectionFunction <optional>
0 Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See
getZForResolution
.