Classes
Type Definitions
-
Options{Object}
-
Properties:
Name Type Argument Default Description attributions
module:ol/source/Source~AttributionLike <optional>
Attributions.
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 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.imageSmoothing
boolean <optional>
true Deprecated. Use the
interpolate
option instead.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.
projection
module:ol/proj~ProjectionLike <optional>
Projection.
tilePixelRatio
number <optional>
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
reprojectionErrorThreshold
number <optional>
0.5 Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
url
string URL template or base URL of the Zoomify service. A base URL is the fixed part of the URL, excluding the tile group, z, x, and y folder structure, e.g.
http://my.zoomify.info/IMAGE.TIF/
. A URL template must include{TileGroup}
,{x}
,{y}
, and{z}
placeholders, e.g.http://my.zoomify.info/IMAGE.TIF/{TileGroup}/{z}-{x}-{y}.jpg
. Internet Imaging Protocol (IIP) with JTL extension can be also used with{tileIndex}
and{z}
placeholders, e.g.http://my.zoomify.info?FIF=IMAGE.TIF&JTL={z},{tileIndex}
. A{?-?}
template pattern, for examplesubdomain{a-f}.domain.com
, may be used instead of defining each one separately in theurls
option.tierSizeCalculation
string <optional>
Tier size calculation method:
default
ortruncated
.size
module:ol/size~Size Size.
extent
module:ol/extent~Extent <optional>
Extent for the TileGrid that is created. Default sets the TileGrid in the fourth quadrant, meaning extent is
[0, -height, width, 0]
. To change the extent to the first quadrant (the default for OpenLayers 2) set the extent as[0, 0, width, height]
.transition
number <optional>
Duration of the opacity transition for rendering. To disable the opacity transition, pass
transition: 0
.tileSize
number <optional>
256 Tile size. Same tile size is used for all zoom levels.
zDirection
number | module:ol/array~NearestDirectionFunction <optional>
0 Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See
module:ol/tilegrid/TileGrid~TileGrid#getZForResolution
.