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 390

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

События:

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

Расширяет

DataTileSource

Методы

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

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

clear() унаследованный source/Tile.js, строка 257

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

dispatchEvent(event){boolean | undefined} унаследованный events/Target.js, строка 85

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

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

Возвращает:

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

get(key){*} унаследованный Object.js, строка 135

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

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

Возвращает:

Значение.

getAttributions(){Attribution} унаследованный source/Source.js, строка 129

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

Возвращает:

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

getAttributionsCollapsible(){boolean} унаследованный source/Source.js, строка 137

Возвращает:

Атрибуции могут быть свёрнуты.

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

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

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

Возвращает:

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

getKeys(){Array.<string>} унаследованный Object.js, строка 148

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

Возвращает:

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

getProjection(){Projection | null} унаследованный source/Source.js, строка 146

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

Возвращает:

Проекцию.

getProperties(){Object.<string, *>} унаследованный Object.js, строка 157

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

Возвращает:

Объект.

getRevision(){number} унаследованный Observable.js, строка 79

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

Возвращает:

Номер ревизии.

getState(){State} унаследованный source/Source.js, строка 170

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

Возвращает:

Состояние.

getTileGrid(){TileGrid | null} унаследованный source/Tile.js, строка 189

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

Возвращает:

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

on(type, listener){EventsKey | Array<EventsKey>} унаследованный Observable.js, строка 152

Присоединение к определённому типу события.

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

Возвращает:

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

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

setAuth(auth) source/SentinelHub.js, line 468

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

Name Type Description

auth

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

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

setData(data) source/SentinelHub.js, line 509

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

Name	Type	Description
`data`	Array<ProcessRequestInputDataItem>	Конфигурация входных данных.

setEvalscript(evalscript) source/SentinelHub.js, line 524

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

Name Type Description

evalscript

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

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

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

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

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

setTileGridForProjection(projection, tilegrid) inherited source/DataTile.js, line 407

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

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

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

un(type, listener) inherited Observable.js, строка 173

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

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

unset(key, silent) inherited Object.js, строка 259

Снимает установку свойства.

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