Raster~RasterSource

import RasterSource from 'ol/source/Raster.js';

Источник, преобразующий данные из любого количества входных источников с помощью функции Operation, которая преобразует значения входных пикселей в значения выходных пикселей.

new RasterSource(options) source/Raster.js, строка 518

Имя	Тип	Описание
`sources`	Array.<(module:ol/source/Source~Source\|module:ol/layer/Layer~Layer)>	Входные источники или слои.
`operation`	Operation \| undefined	Растровая операция. Операция будет вызвана с данными из входных источников, а результат будет назначен растровому источнику.
`interpolate`	boolean (по умолчанию true)	Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение `false`, чтобы использовать метод ближайшего соседа.
`lib`	Object \| undefined	Функции, доступные операциям, выполняемым в рабочем потоке.
`threads`	number \| undefined	По умолчанию операции выполняются в одном рабочем потоке. Чтобы полностью отказаться от использования рабочих потоков, установите значение `threads: 0`. Операции над пикселями можно выполнять в нескольких рабочих потоках. Учтите, что передача данных нескольким рабочим потокам создает дополнительную нагрузку, а возможность распараллеливания работы зависит от системы пользователя.
`operationType`	RasterOperationType (по умолчанию 'pixel')	Тип операции. Поддерживаются значения `'pixel'` и `'image'`. По умолчанию предполагаются операции `'pixel'`, и операции будут вызываться с массивом пикселей из входных источников. Если задано значение `'image'`, операции будут вызываться с массивом объектов ImageData из входных источников.
`resolutions`	Array.<number> \| null \| undefined	Разрешения. Если указаны, растровые операции будут выполняться только для заданных разрешений. По умолчанию используются разрешения первого источника, для которого они заданы, если такой источник есть. Установите значение `null`, чтобы использовать любое разрешение представления.

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

afteroperations (RasterSourceEvent) — генерируется после выполнения операций. Обработчики получат объект события со свойством data. Если используется несколько потоков, data будет массивом объектов. Если используется один поток, data будет одним объектом.
beforeoperations (RasterSourceEvent) — генерируется перед выполнением операций. Обработчики получат объект события со свойством data, которое можно использовать для передачи данных операциям.
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.

dispose() source/Raster.js, строка 915

Освобождает ресурсы и отменяет регистрацию рабочего потока.

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`.

setOperation(operation, lib) source/Raster.js, строка 670

Задает операцию.

Имя	Тип	Описание
`operation`	Operation	Новая операция.
`lib`	Object \| 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	Удалить без вызова события.