ImageCanvas~ImageCanvasSource

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

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

new ImageCanvasSource(options) source/ImageCanvas.js, строка 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 размер canvas совпадает с размером области просмотра карты, при значении 2 ширина и высота canvas вдвое больше, чем у области просмотра карты, и т. д. Значение должно быть не меньше `1`.
`resolutions`	Array.<number> \| undefined	Разрешения. Если указаны, для этих разрешений будут созданы новые элементы canvas.
`state`	State \| undefined	Состояние источника.

Генерирует события:

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

Расширяет

ImageSource

Методы

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

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

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.

Возвращает:

Состояние.

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	Обновить без отправки события.

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

Отменяет подписку на события заданного типа.

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

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

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

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