SentinelHub~SentinelHub

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

Источник тайлов, который создает тайлы с помощью API обработки Sentinel Hub. Все параметры конструктора необязательны, однако источник не будет готов к отображению, пока не будут заданы свойства auth, data и evalscript. Их можно задать после создания объекта с помощью методов setAuth, setData и setEvalscript.

Если при настройке источника или получении токена доступа возникают ошибки, будет вызвано событие change, а состояние источника будет установлено в error. Подробные сведения об обработке этих ошибок см. в методе getError.

new SentinelHub(options) source/SentinelHub.js, line 406

Имя	Тип	Описание
`auth`	AuthConfig \| string \| undefined	Конфигурация аутентификации с `clientId` и `clientSecret` или токен доступа. Подробности см. в разделе Аутентификация Sentinel Hub. Если параметр не задан в конструкторе, источник не будет отображаться, пока не будет вызван метод `setAuth`.
`data`	Array<ProcessRequestInputDataItem> \| undefined	Конфигурация входных данных. Если параметр не задан в конструкторе, источник не будет отображаться, пока не будет вызван метод `setData`.
`evalscript`	Evalscript \| string \| undefined	Обработка, применяемая к входным данным. Если параметр не задан в конструкторе, источник не будет отображаться, пока не будет вызван метод `setEvalscript`. Сведения об ограничениях при передаче функций обработки см. в документации `setEvalscript`.
`tileSize`	number \| Size (defaults to [512, 512])	Ширина и высота тайлов источника в пикселях.
`url`	string (defaults to 'https://services.sentinel-hub.com/api/v1/process')	URL API обработки Sentinel Hub.
`projection`	ProjectionLike \| undefined	Проекция. По умолчанию используется проекция представления.
`attributionsCollapsible`	boolean (defaults to true)	Разрешить сворачивать атрибуцию.
`interpolate`	boolean (defaults to true)	Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение false, чтобы вместо нее использовать метод ближайшего соседа.
`wrapX`	boolean (defaults to true)	Оборачивать мир по горизонтали.
`transition`	number \| undefined	Длительность перехода прозрачности при отображении. Чтобы отключить переход прозрачности, передайте `transition: 0`.
`format`	string (defaults to 'image/png')	Тип MIME для каждого ответа на запрос обработки (`responses[].format.type`), например `image/png` или `image/jpeg`.

Вызывает события:

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

Наследует

DataTileSource

Методы

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

Возвращает:

Атрибуцию можно свернуть.

getError(){Error | null} source/SentinelHub.js, строка 689

Если состояние источника — error, используйте эту функцию, чтобы получить дополнительную информацию об ошибке. Для отладки ошибочной конфигурации можно использовать обработчик, например:

source.on('change', () => {
  if (source.getState() === 'error') {
    console.error(source.getError());
  }
});

Возвращает:

Ошибку загрузки источника.

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

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

Возвращает:

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

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

setAuth(auth) source/SentinelHub.js, строка 496

Задаёт конфигурацию аутентификации для источника (если она не была задана в конструкторе). Если передан объект со свойствами clientId и clientSecret, будет получен токен доступа, который будет использоваться для запросов обработки. В качестве альтернативы можно напрямую передать токен доступа.

Имя Тип Описание

auth

Конфигурация аутентификации или токен доступа.

Имя	Тип	Описание
`tokenUrl`	string (по умолчанию 'https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token')	URL для получения токена аутентификации.
`clientId`	string	Идентификатор клиента.
`clientSecret`	string	Секрет клиента.

setData(data) source/SentinelHub.js, строка 537

Задаёт или обновляет используемые входные данные.

Имя	Тип	Описание
`data`	Array<ProcessRequestInputDataItem>	Конфигурация входных данных.

setEvalscript(evalscript) source/SentinelHub.js, строка 568

Задаёт или обновляет Evalscript, используемый для обработки данных. Можно передать объект процесса или строку Evalscript. Если передан объект процесса, он будет сериализован для получения строки Evalscript. Поскольку эти функции будут сериализованы и выполнены Processing API, они не могут обращаться к другим переменным или функциям, не предоставленным контекстом Processing API.

Имя Тип Описание

evalscript

Процесс, применяемый к входным данным.

Имя	Тип	Описание
`setup`	Setup	Функция настройки.
`evaluatePixel`	EvaluatePixel	Функция преобразования входных выборок в выходные значения.
`updateOutput`	UpdateOutput \| undefined	Необязательная функция настройки выходных диапазонов.
`updateOutputMetadata`	UpdateOutputMetadata \| undefined	Необязательная функция обновления метаданных выходных данных.
`preProcessScenes`	Collections \| undefined	Необязательная функция, вызываемая перед обработкой.
`version`	string (по умолчанию '3')	Версия Evalscript.

setFormat(format) source/SentinelHub.js, строка 548

Задаёт тип MIME для ответов с тайлами Process API (responses[].format.type).

Имя	Тип	Описание
`format`	string	Тип формата (например, `image/png` или `image/jpeg`).

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

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

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

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

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

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

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

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

Прекращает ожидание события указанного типа.

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

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

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

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