OpenLayers v6.6.2-dev API

Class: IIIF

ol/source/IIIF~IIIF

import IIIF from 'ol/source/IIIF';

Layer source for IIIF Image API services.

new IIIF(opt_options) source/IIIF.js, line 60

Name Type Description

options

Tile source options. Use module:ol/format/IIIFInfo~IIIFInfo to parse Image API service information responses into constructor options.

Name	Type	Description
`attributions`	module:ol/source/Source~AttributionLike	Attributions.
`attributionsCollapsible`	boolean (defaults to true)	Attributions are collapsible.
`cacheSize`	number	Size of the cache.
`crossOrigin`	null \| string	The value for the crossOrigin option of the request.
`extent`	module:ol/extent~Extent (defaults to [0, -height, width, 0])	The extent.
`format`	string (defaults to 'jpg')	Requested image format.
`imageSmoothing`	boolean (defaults to true)	Enable image smoothing.
`projection`	module:ol/proj~ProjectionLike	Projection.
`quality`	string	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>	Supported resolutions as given in IIIF 'scaleFactors'
`size`	module:ol/size~Size	Size of the image [width, height].
`sizes`	Array.<module:ol/size~Size>	Supported scaled image sizes. Content of the IIIF info.json 'sizes' property, but as array of Size objects.
`state`	module:ol/source/State	Source state.
`supports`	Array.<string> (defaults to [])	Supported IIIF region and size calculation features.
`tilePixelRatio`	number	Tile pixel ratio.
`tileSize`	number \| module:ol/size~Size	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	Transition.
`url`	string	Base URL of the IIIF Image service. This should be the same as the IIIF Image ID.
`version`	module:ol/format/IIIFInfo~Versions (defaults to Versions.VERSION2)	Service's IIIF Image API version.
`zDirection`	number \| module:ol/array~NearestDirectionFunction (defaults to 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`.

Fires:

change (module:ol/events/Event~BaseEvent) - Generic change event. Triggered when the revision counter is increased.
error (module:ol/events/Event~BaseEvent) - Generic error event. Triggered when an error occurs.
propertychange (module:ol/Object.ObjectEvent) - Triggered when a property is changed.
tileloadend (module:ol/source/Tile.TileSourceEvent) - Triggered when a tile finishes loading, either when its data is loaded, or when loading was aborted because the tile is no longer needed.
tileloaderror (module:ol/source/Tile.TileSourceEvent) - Triggered if tile loading results in an error.
tileloadstart (module:ol/source/Tile.TileSourceEvent) - Triggered when a tile starts loading.

Extends

module:ol/source/TileImage~TileImage

Methods

changed() inherited Observable.js, line 70

Increases the revision counter and dispatches a 'change' event.

clear() inherited source/Tile.js, line 336

Remove all cached tiles from the source. The next render cycle will fetch new tiles.

dispatchEvent(event){boolean|undefined} inherited events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
`event`	module:ol/events/Event~BaseEvent \| string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited Object.js, line 135

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getAttributions(){module:ol/source/Source~Attribution} inherited source/Source.js, line 100

Get the attribution function for the source.

Returns:

Attribution function.

getAttributionsCollapsible(){boolean} inherited source/Source.js, line 108

Returns:

Attributions are collapsible.

getKeys(){Array.<string>} inherited Object.js, line 148

Get a list of object property names.

Returns:

List of property names.

getProjection(){module:ol/proj/Projection~Projection} inherited source/Source.js, line 117

Get the projection of the source.

Returns:

Projection.

getProperties(){Object.<string, *>} inherited Object.js, line 157

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited Observable.js, line 81

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getState(){module:ol/source/State} inherited source/Source.js, line 134

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:

State.

getTileGrid(){module:ol/tilegrid/TileGrid~TileGrid} inherited source/Tile.js, line 256

Return the tile grid of the tile source.

Returns:

Tile grid.

getTileLoadFunction(){module:ol/Tile~LoadFunction} inherited source/UrlTile.js, line 98

Return the tile load function of the source.

Returns:

TileLoadFunction

getTileUrlFunction(){module:ol/Tile~UrlFunction} inherited source/UrlTile.js, line 107

Return the tile URL function of the source.

Returns:

TileUrlFunction

getUrls(){!Array.<string>|null} inherited source/UrlTile.js, line 120

Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

Returns:

URLs.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 155

Listen for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 167

Listen once for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

refresh() inherited source/Source.js, line 156

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, opt_silent) inherited Object.js, line 203

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.
`silent`	boolean	Update without triggering an event.

setAttributions(attributions) inherited source/Source.js, line 167

Set the attributions of the source.

Name	Type	Description
`attributions`	module:ol/source/Source~AttributionLike \| undefined	Attributions. Can be passed as `string`, `Array<string>`, `module:ol/source/Source~Attribution`, or `undefined`.

setProperties(values, opt_silent) inherited Object.js, line 223

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
`values`	Object.<string, *>	Values.
`silent`	boolean	Update without triggering an event.

setRenderReprojectionEdges(render) inherited source/TileImage.js, line 429

Sets whether to render reprojection edges or not (usually for debugging).

Name	Type	Description
`render`	boolean	Render the edges.

setTileGridForProjection(projection, tilegrid) inherited source/TileImage.js, line 455

Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

Name	Type	Description
`projection`	module:ol/proj~ProjectionLike	Projection.
`tilegrid`	module:ol/tilegrid/TileGrid~TileGrid	Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited source/UrlTile.js, line 156

Set the tile load function of the source.

Name	Type	Description
`tileLoadFunction`	module:ol/Tile~LoadFunction	Tile load function.

setTileUrlFunction(tileUrlFunction, key) inherited source/UrlTile.js, line 168

Set the tile URL function of the source.

Name	Type	Description
`tileUrlFunction`	module:ol/Tile~UrlFunction	Tile URL function.
`key`	string	Optional new tile key for the source.

setUrl(url) inherited source/UrlTile.js, line 183

Set the URL to use for requests.

Name	Type	Description
`url`	string	URL.

setUrls(urls) inherited source/UrlTile.js, line 194

Set the URLs to use for requests.

Name	Type	Description
`urls`	Array.<string>	URLs.

un(type, listener) inherited Observable.js, line 176

Unlisten for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

unset(key, opt_silent) inherited Object.js, line 247

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean	Unset without triggering an event.