Module: ol/source/IIIF

Classes

IIIF

Type Definitions

Options{Object}

Properties:

Name	Type	Argument	Default	Description
attributions	AttributionLike	<optional>		Attributions.
attributionsCollapsible	boolean	<optional>	true	Attributions are collapsible.
cacheSize	number	<optional>		Size of the cache.
crossOrigin	null | string	<optional>		The value for the crossOrigin option of the request.
extent	Extent	<optional>	[0, -height, width, 0]	The extent.
format	string	<optional>	'jpg'	Requested image format.
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	ProjectionLike	<optional>		Projection.
quality	string	<optional>		Requested IIIF image quality. Default is 'native' for version 1, 'default' for versions 2 and 3.
reprojectionErrorThreshold	number	<optional>	0.5	Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
resolutions	Array.<number>	<optional>		Supported resolutions as given in IIIF 'scaleFactors'
size	Size			Size of the image [width, height].
sizes	Array<Size>	<optional>		Supported scaled image sizes. Content of the IIIF info.json 'sizes' property, but as array of Size objects.
state	State	<optional>		Source state.
supports	Array.<string>	<optional>	[]	Supported IIIF region and size calculation features.
tilePixelRatio	number	<optional>		Tile pixel ratio.
tileSize	number | Size	<optional>		Tile size. Same tile size is used for all zoom levels. If tile size is a number, a square tile is assumed. If the IIIF image service supports arbitrary tiling (sizeByH, sizeByW, sizeByWh or sizeByPct as well as regionByPx or regionByPct are supported), the default tilesize is 256.
transition	number	<optional>		Transition.
url	string	<optional>		Base URL of the IIIF Image service. This should be the same as the IIIF Image ID.
version	Versions	<optional>	Versions.VERSION2	Service's IIIF Image API version.
zDirection	number | NearestDirectionFunction	<optional>	0	Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.