Module: ol/source/IIIF

ol/source/IIIF


Classes

IIIF

Type Definitions

Options{Object}

Properties:
Name Type Description
attributions AttributionLike | undefined

Attributions.

attributionsCollapsible boolean
(defaults to true)

Attributions are collapsible.

cacheSize number | undefined

Deprecated. Use the cacheSize option on the layer instead.

crossOrigin null | string | undefined

The value for the crossOrigin option of the request.

extent Extent
(defaults to [0, -height, width, 0])

The extent.

format string
(defaults to 'jpg')

Requested image format.

interpolate boolean
(defaults to 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 | undefined

Projection.

quality string | undefined

Requested IIIF image quality. Default is 'native' for version 1, 'default' for versions 2 and 3.

reprojectionErrorThreshold number
(defaults to 0.5)

Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.

resolutions Array.<number> | undefined

Supported resolutions as given in IIIF 'scaleFactors'

size Size

Size of the image [width, height].

sizes Array<Size> | undefined

Supported scaled image sizes. Content of the IIIF info.json 'sizes' property, but as array of Size objects.

state State | undefined

Source state.

supports Array.<string>
(defaults to [])

Supported IIIF region and size calculation features.

tilePixelRatio number | undefined

Tile pixel ratio.

tileSize number | Size | undefined

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 | undefined

Transition.

url string | undefined

Base URL of the IIIF Image service. This should be the same as the IIIF Image ID.

version Versions
(defaults to Versions.VERSION2)

Service's IIIF Image API version.

zDirection number | NearestDirectionFunction
(defaults to 0)

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.