IIIF~IIIF

import IIIF from 'ol/source/IIIF.js';

Источник слоя для сервисов IIIF Image API.

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

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуция.
`attributionsCollapsible`	boolean (по умолчанию true)	Атрибуция может быть свёрнута.
`cacheSize`	number \| undefined	Устарело. Используйте параметр cacheSize слоя.
`crossOrigin`	null \| string \| undefined	Значение параметра crossOrigin запроса.
`extent`	Extent (по умолчанию [0, -height, width, 0])	Экстент.
`format`	string (по умолчанию 'jpg')	Запрашиваемый формат изображения.
`interpolate`	boolean (по умолчанию true)	Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение false, чтобы использовать метод ближайшего соседа.
`projection`	ProjectionLike \| undefined	Проекция.
`quality`	string \| undefined	Запрашиваемое качество изображения IIIF. По умолчанию для версии 1 используется 'native', для версий 2 и 3 — 'default'.
`reprojectionErrorThreshold`	number (по умолчанию 0.5)	Максимально допустимая погрешность перепроецирования (в пикселях). Более высокие значения могут повысить производительность перепроецирования, но снизить точность.
`resolutions`	Array.<number> \| undefined	Поддерживаемые разрешения, указанные в IIIF 'scaleFactors'
`size`	Size	Размер изображения [width, height].
`sizes`	Array<Size> \| undefined	Поддерживаемые размеры масштабированных изображений. Содержимое свойства 'sizes' объекта IIIF info.json, представленное в виде массива объектов Size.
`state`	State \| undefined	Состояние источника.
`supports`	Array.<string> (по умолчанию [])	Поддерживаемые возможности IIIF для вычисления области и размера.
`tilePixelRatio`	number \| undefined	Пиксельный коэффициент тайла.
`tileSize`	number \| Size \| undefined	Размер тайла. Для всех уровней масштабирования используется один и тот же размер тайла. Если размер тайла задан числом, предполагается, что тайл квадратный. Если сервис изображений IIIF поддерживает произвольное разбиение на тайлы (поддерживаются sizeByH, sizeByW, sizeByWh или sizeByPct, а также regionByPx или regionByPct), размер тайла по умолчанию равен 256.
`transition`	number \| undefined	Переход.
`url`	string \| undefined	Базовый URL сервиса IIIF Image. Он должен совпадать с идентификатором изображения IIIF.
`version`	Versions (по умолчанию Versions.VERSION2)	Версия IIIF Image API сервиса.
`zDirection`	number \| NearestDirectionFunction (по умолчанию 0)	Выбор тайлов с более высоким или низким уровнем масштабирования при значениях масштаба между целыми числами. См. `getZForResolution`.

События:

change (BaseEvent) — Общее событие изменения. Вызывается при увеличении счётчика ревизий.
error (BaseEvent) — Общее событие ошибки. Вызывается при возникновении ошибки.
propertychange (ObjectEvent) — Вызывается при изменении свойства.
tileloadend (TileSourceEvent) — Вызывается, когда загрузка тайла завершается: данные загружены или загрузка прервана, поскольку тайл больше не нужен.
tileloaderror (TileSourceEvent) — Вызывается, если при загрузке тайла возникает ошибка. Обратите внимание: это событие не следует использовать для повторной загрузки тайлов. Подробнее см. load.
tileloadstart (TileSourceEvent) — Вызывается при начале загрузки тайла.

Расширяет

TileImage

Методы

changed() унаследовано Observable.js, строка 68

Увеличивает счётчик ревизий и отправляет событие «change».

clear() унаследовано source/Tile.js, строка 258

Удаляет все кэшированные перепроецированные тайлы из источника. При следующем цикле отображения будут созданы новые тайлы.

dispatchEvent(event){boolean | undefined} унаследовано events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, подписанные на события этого типа. Параметр event может быть строкой или объектом со свойством type.

Имя	Тип	Описание
`event`	BaseEvent \| string	Объект события.

Возвращает:

false, если кто-либо вызвал preventDefault для объекта события или если любой из обработчиков вернул false.

get(key){*} унаследовано Object.js, строка 136

Получает значение.

Имя	Тип	Описание
`key`	string	Имя ключа.

Возвращает:

Значение.

getAttributions(){Attribution} унаследовано source/Source.js, строка 129

Получает функцию атрибуции для источника.

Возвращает:

Функция атрибуции.

getAttributionsCollapsible(){boolean} унаследовано source/Source.js, строка 137

Возвращает:

Атрибуции можно сворачивать.

getKeys(){Array.<string>} унаследовано Object.js, строка 149

Получает список имён свойств объекта.

Возвращает:

Список имён свойств.

getProjection(){Projection | null} унаследовано source/Source.js, строка 146

Получает проекцию источника.

Возвращает:

Проекция.

getProperties(){NoInfer.<Properties>} унаследовано Object.js, строка 158

Получает объект со всеми именами и значениями свойств.

Возвращает:

Объект.

getRevision(){number} унаследовано Observable.js, строка 79

Получает номер версии этого объекта. При каждом изменении объекта номер его версии увеличивается.

Возвращает:

Ревизия.

getState(){State} унаследовано source/Source.js, строка 201

Получает состояние источника. Возможные состояния см. в State.

Возвращает:

Состояние.

getTileGrid(){TileGrid | null} унаследовано source/Tile.js, строка 190

Возвращает сетку тайлов источника.

Возвращает:

Сетка тайлов.

getTileLoadFunction(){LoadFunction} унаследовано source/UrlTile.js, строка 100

Устарело. Вместо этого используйте источник ImageTile. Возвращает функцию загрузки тайлов источника.

Возвращает:

TileLoadFunction

getTileUrlFunction(){UrlFunction} унаследовано source/UrlTile.js, строка 110

Устарело. Вместо этого используйте источник ImageTile. Возвращает функцию URL тайлов источника.

Возвращает:

TileUrlFunction

getUrls(){!Array.<string> | null} унаследовано source/UrlTile.js, строка 124

Устарело. Вместо этого используйте источник ImageTile. Возвращает URL-адреса, используемые для этого источника. Если вместо url или urls используется tileUrlFunction, будет возвращено значение null.

Возвращает:

URL-адреса.

on(type, listener){EventsKey | Array<EventsKey>} унаследовано Observable.js, строка 152

Подписывается на событие определённого типа.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

Возвращает:

Уникальный ключ обработчика. Если первым аргументом передан массив типов событий, возвращается массив ключей.

once(type, listener){EventsKey | Array<EventsKey>} унаследовано Observable.js, строка 164

Однократно подписывается на событие определённого типа.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

Возвращает:

refresh() унаследовано source/Source.js, строка 223

Обновляет источник. Источник будет очищен, а данные с сервера загружены повторно.

set(key, value, silent) унаследовано Object.js, строка 218

Задаёт значение.

Имя	Тип	Описание
`key`	string	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновить без вызова события.

setAttributions(attributions) унаследовано source/Source.js, строка 234

Задаёт атрибуции источника.

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуции. Можно передать как `string`, `Array<string>`, `Attribution` или `undefined`.

setProperties(values, silent) унаследовано Object.js, строка 238

Задаёт набор пар «ключ — значение». Обратите внимание: это изменяет существующие свойства и добавляет новые, но не удаляет существующие свойства.

Имя	Тип	Описание
`values`	Partial.<NoInfer.<Properties>>	Значения.
`silent`	boolean \| undefined	Обновить без вызова события.

setRenderReprojectionEdges(render) унаследовано source/TileImage.js, строка 301

Задаёт, следует ли отображать границы перепроецирования (обычно используется для отладки).

Имя	Тип	Описание
`render`	boolean	Отображать границы.

setTileGridForProjection(projection, tilegrid) унаследовано source/TileImage.js, строка 321

Задаёт сетку тайлов, которую следует использовать при перепроецировании тайлов в указанную проекцию вместо сетки тайлов, используемой для этой проекции по умолчанию.

Это может быть полезно, если сетку тайлов по умолчанию нельзя создать (например, для проекции не задана область охвата) или в целях оптимизации (пользовательский размер тайла, разрешения и т. д.).

Имя	Тип	Описание
`projection`	ProjectionLike	Проекция.
`tilegrid`	TileGrid	Сетка тайлов, используемая для проекции.

setTileLoadFunction(tileLoadFunction) унаследовано source/UrlTile.js, строка 161

Устарело. Вместо этого используйте источник ImageTile. Задаёт функцию загрузки тайлов источника.

Имя	Тип	Описание
`tileLoadFunction`	LoadFunction	Функция загрузки тайлов.

setTileUrlFunction(tileUrlFunction, key) унаследовано source/UrlTile.js, строка 173

Устарело. Вместо этого используйте источник ImageTile. Задаёт функцию URL тайлов источника.

Имя	Тип	Описание
`tileUrlFunction`	UrlFunction	Функция URL тайлов.
`key`	string \| undefined	Новый необязательный ключ тайла для источника.

setUrl(url) унаследовано source/UrlTile.js, строка 187

Задаёт URL-адрес для запросов.

Имя	Тип	Описание
`url`	string	URL-адрес.

setUrls(urls) унаследовано source/UrlTile.js, строка 199

Устарело. Вместо этого используйте источник ImageTile. Задаёт URL-адреса для запросов.

Имя	Тип	Описание
`urls`	Array.<string>	URL-адреса.

un(type, listener) унаследовано Observable.js, строка 173

Отписывается от событий определённого типа.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

unset(key, silent) унаследовано Object.js, строка 262

Удаляет свойство.

Имя	Тип	Описание
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Удалить без вызова события.