ImageCanvas~ImageCanvasSource

import ImageCanvasSource from 'ol/source/ImageCanvas.js';

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

new ImageCanvasSource(options) source/ImageCanvas.js, line 54

Имя	Тип	Описание
`attributions`	AttributionLike \| undefined	Атрибуции.
`canvasFunction`	FunctionType \| undefined	Функция canvas. Функция, возвращающая элемент canvas, используемый источником в качестве изображения. Аргументами функции являются: `Extent` область изображения, `{number}` разрешение изображения, `{number}` коэффициент пикселей карты, `Size` размер изображения и `Projection` проекция изображения. Canvas, возвращаемый этой функцией, кэшируется источником. Если возвращаемое значение функции впоследствии изменится, то необходимо вызвать `changed` на источнике, чтобы источник аннулировал текущее кэшированное изображение. См.: `changed`
`interpolate`	boolean (по умолчанию true)	Использовать интерполированные значения при ресемплировании. По умолчанию используется линейная интерполяция при ресемплировании. Установите в значение false, чтобы использовать ближайшего соседа вместо этого.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию используется проекция представления.
`ratio`	number (по умолчанию 1.5)	Коэффициент. 1 означает, что холсты имеют размер области просмотра карты, 2 означает вдвое большую ширину и высоту области просмотра карты и так далее. Должно быть `1` или больше.
`resolutions`	Array.<number> \| undefined	Разрешения. Если указаны, новые холсты будут созданы для этих разрешений.
`state`	State \| undefined	Состояние источника.

События:

change (BaseEvent) - Общее событие изменения. Срабатывает при увеличении счетчика ревизии.
error (BaseEvent) - Общее событие ошибки. Срабатывает при возникновении ошибки.
imageloadend (ImageSourceEvent) - Срабатывает при завершении загрузки изображения.
imageloaderror (ImageSourceEvent) - Срабатывает, если загрузка изображения привела к ошибке.
imageloadstart (ImageSourceEvent) - Срабатывает при запуске загрузки изображения.
propertychange (ObjectEvent) - Срабатывает при изменении свойства.

Расширяет

ImageSource

Методы

changed() inherited Observable.js, line 68

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

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

Отправляет событие и вызывает всех слушателей, которые слушают события этого типа. Параметр event может быть строкой или объектом с свойством 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 для возможных состояний.

Возвращает:

Состояние.

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

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

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

Возвращает:

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

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

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

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

Возвращает:

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

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

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

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

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

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

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

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

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

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

Имя	Тип	Описание
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновить без срабатывания события.

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

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

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

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

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

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