Class: IIIFInfo

ol/format/IIIFInfo~IIIFInfo


import IIIFInfo from 'ol/format/IIIFInfo';

Format for transforming IIIF Image API image information responses into IIIF tile source ready options

new IIIFInfo(imageInfo)

Name Type Description
imageInfo string | module:ol/format/IIIFInfo~ImageInformationResponse

Deserialized image information JSON response object or JSON response as string

Methods

getImageApiVersion(){module:ol/format/IIIFInfo~Versions}

Returns:
Major IIIF version.

getTileSourceOptions(opt_preferredOptions){module:ol/source/IIIF~Options}

Name Type Description
preferredOptions

Optional options for preferred format and quality.

Name Type Description
format string | undefined

Preferred image format. Will be used if the image information indicates support for that format.

quality string | undefined

IIIF image qualitiy. Will be used if the image information indicates support for that quality.

Returns:
IIIF tile source ready constructor options.

setImageInfo(imageInfo)

Name Type Description
imageInfo string | module:ol/format/IIIFInfo~ImageInformationResponse

Deserialized image information JSON response object or JSON response as string