Stac Collection Render Options - Create

Служба:
Planetary Computer
Версия API:
2026-04-15

Добавить опцию рендеринга коллекции
Добавление опции рендеринга для заданной коллекции

POST {endpoint}/stac/collections/{collectionId}/configurations/render-options?api-version=2026-04-15

Параметры URI

Имя В Обязательно Тип Описание
collectionId
 path True

string

maxLength: 500
pattern: .*

Уникальный идентификатор для коллекции STAC.
endpoint
 path True

string (uri)

Endpoint GeoCatalog, например, https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
id True

string

minLength: 1
maxLength: 30
pattern: ^(?!\-|_)[a-zA-Z0-9_-]*(?

Уникальный идентификатор для опции рендеринга.
name True

string

maxLength: 40

Краткое описательное имя для опции рендеринга.
conditions

RenderOptionCondition[]

Список условий свойства/значения, которые должны быть в активном CQL мозаики, чтобы этот параметр рендеринга был включен
description

string

Более подробное описание опции рендеринга, которое можно использовать для объяснения ее содержимого.
legend

RenderOptionLegend

Конфигурация легенды для этого параметра рендеринга.
minZoom

integer (int32)

maximum: 24

Минимальный уровень масштабирования, при котором будет отображаться этот слой.
options

string

Строка запроса URL, закодированная в строке запроса с параметрами рендеринга TiTiTiler. Справедливо только для raster-tile типов.

См. параметры запроса.
type

RenderOptionType

Тип применяемого рендеринга (растровый или векторный).
vectorOptions

RenderOptionVectorOptions

Варианты рендеринга векторных тайлов. Действительно только для vt-polygon и vt-line типов.

Ответы

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

RenderOption

Запрос успешно выполнен, и в результате был создан новый ресурс.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
https://geocatalog.spatio.azure.com/.default

Примеры

StacCollectionRenderOptions_Create

Образец запроса

POST {endpoint}/stac/collections/naip-atl/configurations/render-options?api-version=2026-04-15

{
  "id": "test-natural-color",
  "name": "Test Natural color",
  "type": "raster-tile",
  "options": "assets=image&asset_bidx=image|1,2,3",
  "minZoom": 6
}

Пример ответа

Код состояния:
201 
{
  "id": "test-natural-color",
  "name": "Test Natural color",
  "type": "raster-tile",
  "options": "assets=image&asset_bidx=image|1,2,3",
  "minZoom": 6
}

Определения

Имя Описание
Azure.Core.Foundations.Error

Объект ошибки.
Azure.Core.Foundations.ErrorResponse

Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError

Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
LegendConfigType

Тип легенды для создания: , continuousclassmapinterval , или none (обратите внимание, none это строковый литерал).
RenderOption

Определяет параметры визуализации для отрисовки данных на карте.
RenderOptionCondition

Определяет условие для включения параметра рендеринга.
RenderOptionLegend

Конфигурация для создания легенды данных.
RenderOptionType

Указывает типы параметров отрисовки для визуализации карты.
RenderOptionVectorOptions

Определяет параметры для рендеринга векторных листов.

Azure.Core.Foundations.Error

Объект

Объект ошибки.

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

string

Один из определяемых сервером кодов ошибок.
details

Azure.Core.Foundations.Error[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror

Azure.Core.Foundations.InnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message

string

Читаемое пользователем представление ошибки.
target

string

Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

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

Azure.Core.Foundations.Error

Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

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

string

Один из определяемых сервером кодов ошибок.
innererror

Azure.Core.Foundations.InnerError

Внутренняя ошибка.

LegendConfigType

Перечисление

Тип легенды для создания: , continuousclassmapinterval , или none (обратите внимание, none это строковый литерал).

Значение Описание
continuous

Непрерывная легенда цветовой шкалы.
classmap

Классифицированная карта с дискретными цветами для классов.
interval

Условные обозначения на основе интервалов с дискретными диапазонами.
none

Никакой легенды.

RenderOption

Объект

Определяет параметры визуализации для отрисовки данных на карте.

Имя Тип Default value Описание
conditions

RenderOptionCondition[]

Список условий свойства/значения, которые должны быть в активном CQL мозаики, чтобы этот параметр рендеринга был включен
description

string

Более подробное описание опции рендеринга, которое можно использовать для объяснения ее содержимого.
id

string

minLength: 1
maxLength: 30
pattern: ^(?!\-|_)[a-zA-Z0-9_-]*(?

Уникальный идентификатор для опции рендеринга.
legend

RenderOptionLegend

Конфигурация легенды для этого параметра рендеринга.
minZoom

integer (int32)

maximum: 24 		12

Минимальный уровень масштабирования, при котором будет отображаться этот слой.
name

string

maxLength: 40

Краткое описательное имя для опции рендеринга.
options

string

Строка запроса URL, закодированная в строке запроса с параметрами рендеринга TiTiTiler. Справедливо только для raster-tile типов.

См. параметры запроса.
type

RenderOptionType

raster-tile

Тип применяемого рендеринга (растровый или векторный).
vectorOptions

RenderOptionVectorOptions

Варианты рендеринга векторных тайлов. Действительно только для vt-polygon и vt-line типов.

RenderOptionCondition

Объект

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

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

string

Имя свойства для проверки в активном фильтре CQL.
value

string

Значение, которому должно быть равно свойство.

RenderOptionLegend

Объект

Конфигурация для создания легенды данных.

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

string[]

Текстовые метки для отображения в легенде.
scaleFactor

number (float)

Коэффициент, на который умножаются надписи легенды интервалов. Полезно для масштабированных растров, определения цветовой карты которых сопоставляются с немасштабированными значениями, эффективно отображая надписи легенды как масштабированные значения.
trimEnd

integer (int32)

Количество элементов для обрезки с конца условных обозначений.
trimStart

integer (int32)

Количество элементов для обрезки от начала определения условных обозначений. Используется, если есть значения, важные для рендеринга (например, nodata), которые нежелательны в легенде.
type

LegendConfigType

Тип легенды для создания: , continuousclassmapinterval , или none (обратите внимание, none это строковый литерал).

RenderOptionType

Перечисление

Указывает типы параметров отрисовки для визуализации карты.

Значение Описание
raster-tile

Тип рендеринга растровых тайлов.
vt-polygon

Тип рендеринга полигона векторной плитки.
vt-line

Тип отрисовки линий векторной плитки.

RenderOptionVectorOptions

Объект

Определяет параметры для рендеринга векторных листов.

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

string

Цвет заливки для полигональных объектов.
filter

string[]

Выражение фильтра MapBox GL для фильтрации объектов.
sourceLayer

string

Имя исходного слоя в векторных тайлах.
strokeColor

string

Цвет обводки для линейных объектов.
strokeWidth

integer (int32)

Ширина штрихов линий в пикселях.
tilejsonKey

string

Ключ ресурса, содержащий URL-адрес TileJSON.