Stac Collection Render Options - Create

Serviço:: Planetary Computer

Versão da API:: 2025-04-30-preview

Adicionar opção de renderização de coleção
Adicionar uma opção de renderização para uma determinada coleção

POST https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/{collectionId}/configurations/render-options?api-version=2025-04-30-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Identificador exclusivo para a coleção STAC.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Identificador exclusivo para a opção de renderização.
name	True	string maxLength: 40	Nome descritivo curto para a opção de renderização.
conditions		RenderOptionCondition[]	Uma lista de condições de propriedade/valor que devem estar no CQL de mosaico ativo para que essa opção de renderização seja habilitada
description		string	Uma descrição mais longa da opção de renderização que pode ser usada para explicar seu conteúdo.
legend		RenderOptionLegend	Configuração de legenda para esta opção de renderização.
minZoom		integer (int32) maximum: 24	Nível mínimo de zoom para exibir essa camada.
options		string	Uma cadeia de caracteres codificada de cadeia de caracteres de URL das opções de renderização do TiLer. Válido apenas para `raster-tile` tipos. Consulte 'Parâmetros de consulta': https://developmentseed.org/titiler/endpoints/cog/#description
type		RenderOptionType	O tipo de renderização a ser aplicada (raster ou vetor).
vectorOptions		RenderOptionVectorOptions	Opções para renderizar blocos vetoriais. Válido apenas para `vt-polygon` e `vt-line` tipos.

Respostas

Name	Tipo	Description
200 OK	RenderOption	O pedido foi bem-sucedido.
201 Created	RenderOption	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

RenderOption

O pedido foi bem-sucedido.

201 Created

RenderOption

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://geocatalog.spatio.azure.com/.default

Exemplos

StacCollectionRenderOptions_Create

Pedido de amostra

HTTP

POST https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/36fcb8da-9b15-49e0-b400-0d2e751e2061/configurations/render-options?api-version=2025-04-30-preview

{
  "name": "Atmospheric penetration",
  "description": "False color rendering with non-visible bands to reduce effects of atmospheric particles (B12, B11, B8A).",
  "type": "raster-tile",
  "options": "nodata=0&assets=B12&assets=B11&assets=B8A&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
  "vectorOptions": null,
  "minZoom": 9,
  "legend": null,
  "conditions": null,
  "id": "atmospheric-penetration"
}

Resposta da amostra

Código de estado:: 201

{
  "id": "atmospheric-penetration",
  "name": "Atmospheric penetration",
  "description": "False color rendering with non-visible bands to reduce effects of atmospheric particles (B12, B11, B8A).",
  "type": "raster-tile",
  "options": "nodata=0&assets=B12&assets=B11&assets=B8A&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
  "minZoom": 9
}

Código de estado:: 200

{
  "id": "atmospheric-penetration",
  "name": "Atmospheric penetration",
  "description": "False color rendering with non-visible bands to reduce effects of atmospheric particles (B12, B11, B8A).",
  "type": "raster-tile",
  "options": "nodata=0&assets=B12&assets=B11&assets=B8A&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
  "minZoom": 9
}

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
LegendConfigType	Tipo de legenda a ser feito, um de: `continuous`, `classmap`, `interval` ou `none` (nota, `none` é um literal de cadeia de caracteres). Define os tipos de configuração de legenda para visualização de dados.
RenderOption	Define parâmetros de visualização para renderizar dados em um mapa.
RenderOptionCondition	Define uma condição para habilitar uma opção de renderização.
RenderOptionLegend	Configuração para gerar uma legenda de dados.
RenderOptionType	Especifica os tipos de opções de renderização para visualização de mapa.
RenderOptionVectorOptions	Define parâmetros para renderização de blocos vetoriais.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

LegendConfigType

Enumeração

Tipo de legenda a ser feito, um de: continuous, classmap, interval ou none (nota, none é um literal de cadeia de caracteres). Define os tipos de configuração de legenda para visualização de dados.

Valor	Description
continuous	Legenda contínua da rampa de cores.
classmap	Mapa classificado com cores discretas para as aulas.
interval	Legenda baseada em intervalos com intervalos discretos.
none	Sem lenda.

RenderOption

Object

Define parâmetros de visualização para renderizar dados em um mapa.

Name	Tipo	Default value	Description
conditions	RenderOptionCondition[]		Uma lista de condições de propriedade/valor que devem estar no CQL de mosaico ativo para que essa opção de renderização seja habilitada
description	string		Uma descrição mais longa da opção de renderização que pode ser usada para explicar seu conteúdo.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Identificador exclusivo para a opção de renderização.
legend	RenderOptionLegend		Configuração de legenda para esta opção de renderização.
minZoom	integer (int32) maximum: 24	12	Nível mínimo de zoom para exibir essa camada.
name	string maxLength: 40		Nome descritivo curto para a opção de renderização.
options	string		Uma cadeia de caracteres codificada de cadeia de caracteres de URL das opções de renderização do TiLer. Válido apenas para `raster-tile` tipos. Consulte 'Parâmetros de consulta': https://developmentseed.org/titiler/endpoints/cog/#description
type	RenderOptionType	raster-tile	O tipo de renderização a ser aplicada (raster ou vetor).
vectorOptions	RenderOptionVectorOptions		Opções para renderizar blocos vetoriais. Válido apenas para `vt-polygon` e `vt-line` tipos.

RenderOptionCondition

Object

Define uma condição para habilitar uma opção de renderização.

Name	Tipo	Description
property	string	Nome da propriedade para fazer check-in do filtro CQL ativo.
value	string	Valor que a propriedade deve igualar.

RenderOptionLegend

Object

Configuração para gerar uma legenda de dados.

Name	Tipo	Description
labels	string[]	Rótulos de texto para exibir na legenda.
scaleFactor	number (float)	Um fator para multiplicar rótulos de legenda de intervalo por. Útil para rasters dimensionados cujas definições de mapa de cores são mapeadas para valores não dimensionados, mostrando efetivamente rótulos de legenda como valores dimensionados.
trimEnd	integer (int32)	Número de itens a serem cortados a partir do final da legenda.
trimStart	integer (int32)	O número de itens a serem cortados desde o início da definição da legenda. Usado se houver valores importantes para renderização (por exemplo, nodata) que não são desejáveis na legenda.
type	LegendConfigType	Tipo de legenda a ser feito, um de: `continuous`, `classmap`, `interval` ou `none` (nota, `none` é um literal de cadeia de caracteres).

RenderOptionType

Enumeração

Especifica os tipos de opções de renderização para visualização de mapa.

Valor	Description
raster-tile	Tipo de renderização de bloco raster.
vt-polygon	Tipo de renderização de polígono de mosaico vetorial.
vt-line	Tipo de renderização de linha de mosaico vetorial.

RenderOptionVectorOptions

Object

Define parâmetros para renderização de blocos vetoriais.

Name	Tipo	Description
fillColor	string	Cor de preenchimento para recursos de polígono.
filter	string[]	Expressão de filtro MapBox GL para filtrar recursos.
sourceLayer	string	Nome da camada de origem nos blocos vetoriais.
strokeColor	string	Cor do traçado para recursos de linha.
strokeWidth	integer (int32)	Largura dos traçados de linha em pixels.
tilejsonKey	string	Chave de ativo que contém a URL TileJSON.

Partilhar via

Stac Collection Render Options - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

OAuth2Auth

Âmbitos

Exemplos

StacCollectionRenderOptions_Create

Pedido de amostra

Resposta da amostra

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions