Module: ol/format/IIIFInfo

Classes

IIIFInfo

Members

Versions{string}

Enum representing the major IIIF Image API versions

Properties:

Name	Type	Default	Description
VERSION1	string	version1
VERSION2	string	version2
VERSION3	string	version3

Type Definitions

IiifProfile{Object}

Properties:

Name	Type	Argument	Description
formats	Array.<string>	<optional>	Supported image formats for the image service.
qualities	Array.<string>	<optional>	Supported IIIF image qualities.
supports	Array.<string>	<optional>	Supported features.
maxArea	number	<optional>	Maximum area (pixels) available for this image service.
maxHeight	number	<optional>	Maximum height.
maxWidth	number	<optional>	Maximum width.

ImageInformationResponse{Object.<string, (string|number|Array.<(number|string|module:ol/format/IIIFInfo~IiifProfile)>|Object.<string, number>|module:ol/format/IIIFInfo~TileInfo)>}

PreferredOptions{Object}

Properties:

Name	Type	Argument	Description
format	string	<optional>	Preferred image format. Will be used if the image information indicates support for that format.
quality	string	<optional>	IIIF image qualitiy. Will be used if the image information indicates support for that quality.

SupportedFeatures{Object}

Properties:

Name	Type	Argument	Description
supports	Array.<string>	<optional>	Supported IIIF image size and region calculation features.
formats	Array.<string>	<optional>	Supported image formats.
qualities	Array.<string>	<optional>	Supported IIIF image qualities.

TileInfo{Object}

Properties:

Name	Type	Argument	Description
scaleFactors	Array.<number>		Supported resolution scaling factors.
width	number		Tile width in pixels.
height	number	<optional>	Tile height in pixels. Same as tile width if height is not given.