IIIF~IIIF

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

Источник слоя для служб IIIF Image API.

new IIIF(options) source/IIIF.js, строка 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. По умолчанию 'native' для версии 1, 'default' для версий 2 и 3.
`reprojectionErrorThreshold`	number (по умолчанию 0.5)	Максимальная допустимая ошибка репроекции (в пикселях). Более высокие значения могут увеличить производительность репроекции, но уменьшить точность.
`resolutions`	Array.<number> \| undefined	Поддерживаемые разрешения, указанные в IIIF 'scaleFactors'
`size`	Size	Размер изображения [ширина, высота].
`sizes`	Array<Size> \| undefined	Поддерживаемые размеры масштабированного изображения. Содержимое свойства IIIF info.json 'sizes', но в виде массива объектов Size.
`state`	State \| undefined	Состояние источника.
`supports`	Array.<string> (по умолчанию [])	Поддерживаемые функции расчёта области и размера IIIF.
`tilePixelRatio`	number \| undefined	Соотношение пикселей тайла.
`tileSize`	number \| Size \| undefined	Размер тайла. Один и тот же размер тайла используется для всех уровней масштабирования. Если размер тайла — число, предполагается квадратный тайл. Если служба IIIF Image Service поддерживает произвольное разбиение (sizeByH, sizeByW, sizeByWh или sizeByPct, а также regionByPx или regionByPct), размер тайла по умолчанию равен 256.
`transition`	number \| undefined	Переход.
`url`	string \| undefined	Базовый URL службы IIIF Image. Он должен совпадать с идентификатором IIIF Image.
`version`	Versions (по умолчанию Versions.VERSION2)	Версия API IIIF Image службы.
`zDirection`	number \| NearestDirectionFunction (по умолчанию 0)	Выберите, использовать ли тайлы с более высоким или более низким уровнем масштабирования, когда между целыми уровнями масштабирования. См. `getZForResolution`.

События:

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

Расширяет

TileImage

Методы

changed() inherited Observable.js, line 68

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

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

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

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

Отправляет событие и вызывает всех слушателей, которые слушают события этого типа. Параметр события может быть либо строкой, либо объектом с свойством type.

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

Возвращает:

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

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

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

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

Возвращает:

Значение.

getAttributions(){Attribution} inherited source/Source.js, line 129

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

Возвращает:

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

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

Возвращает:

Атрибуции сворачиваются.

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

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

Возвращает:

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

getProjection(){Projection | null} inherited source/Source.js, line 146

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

Возвращает:

Проекцию.

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

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

Возвращает:

Объект.

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

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

Возвращает:

Ревизию.

getState(){State} inherited source/Source.js, line 170

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

Возвращает:

Состояние.

getTileGrid(){TileGrid | null} inherited source/Tile.js, line 189

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

Возвращает:

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

getTileLoadFunction(){LoadFunction} inherited source/UrlTile.js, line 100

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

Возвращает:

TileLoadFunction

getTileUrlFunction(){UrlFunction} inherited source/UrlTile.js, line 110

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

Возвращает:

TileUrlFunction

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

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

Возвращает:

URL-адреса.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

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

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

Returns:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

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

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

Returns:

set(key, value, silent) inherited Object.js, line 215

Устанавливает значение.

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

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

Устанавливает атрибуты источника.

Name	Type	Description
`attributions`	AttributionLike \| undefined	Атрибуты. Могут быть переданы как `string`, `Array<string>`, `Attribution`, или `undefined`.

setProperties(values, silent) inherited Object.js, line 235

Устанавливает набор пар «ключ-значение». Обратите внимание, что это изменяет любые существующие свойства и добавляет новые (это не удаляет существующие свойства).

Name	Type	Description
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновление без вызова события.

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

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

Name	Type	Description
`render`	boolean	Отображать края.

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

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

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

Name	Type	Description
`projection`	ProjectionLike	Проекция.
`tilegrid`	TileGrid	Сетка тайлов для использования для проекции.

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

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

Name	Type	Description
`tileLoadFunction`	LoadFunction	Функция загрузки тайлов.

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

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

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

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

Установить URL для запросов.

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

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

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

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

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

Отключить прослушивание определенного типа событий.

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

unset(key, silent) inherited Object.js, line 259

Сбросить свойство.

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