Stac Collection Render Options - Create

Servicio:: Planetary Computer

Versión de la API:: 2025-04-30-preview

Agregar opción de renderizado de colección
Agregar una opción de renderizado para una colección determinada

POST https:///stac/collections/{collectionId}/configurations/render-options?api-version=2025-04-30-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Identificador único para la colección STAC.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Identificador único para la opción de renderización.
name	True	string maxLength: 40	Nombre descriptivo corto para la opción de renderización.
conditions		RenderOptionCondition[]	Una lista de condiciones de propiedad/valor que deben estar en el CQL de mosaico activo para que se habilite esta opción de representación
description		string	Una descripción más larga de la opción de renderizado que se puede utilizar para explicar su contenido.
legend		RenderOptionLegend	Configuración de leyenda para esta opción de renderizado.
minZoom		integer (int32) maximum: 24	Nivel de zoom mínimo en el que se va a mostrar esta capa.
options		string	Una cadena codificada de cadena de consulta de URL de opciones de representación de TiTiler. Válido solo para `raster-tile` tipos. Ver Parámetros de consulta.
type		RenderOptionType	El tipo de representación en pantalla que se va a aplicar (ráster o vectorial).
vectorOptions		RenderOptionVectorOptions	Opciones para representar mosaicos vectoriales. Válido solo para `vt-polygon` y `vt-line` tipos.

Respuestas

Nombre	Tipo	Description
201 Created	RenderOption	La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

201 Created

RenderOption

La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

StacCollectionRenderOptions_Create

Solicitud de ejemplo

HTTP

POST https:///stac/collections/naip-atl/configurations/render-options?api-version=2025-04-30-preview

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

Respuesta de muestra

status code:: 201

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

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.
LegendConfigType	Tipo de leyenda que se va a crear, uno de los siguientes: `continuous`, `classmap`, `interval` o `none` (nota, `none` es un literal de cadena).
RenderOption	Define los parámetros de visualización para representar datos en un mapa.
RenderOptionCondition	Define una condición para habilitar una opción de representación.
RenderOptionLegend	Configuración para generar una leyenda de datos.
RenderOptionType	Especifica los tipos de opciones de renderizado para la visualización de mapas.
RenderOptionVectorOptions	Define los parámetros para la representación en teselas vectoriales.

Azure.Core.Foundations.Error

Objeto

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Una representación en lenguaje natural del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Objeto

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto

Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

LegendConfigType

Enumeración

Tipo de leyenda que se va a crear, uno de los siguientes: continuous, classmap, interval o none (nota, none es un literal de cadena).

Valor	Description
continuous	Leyenda de rampa de color continua.
classmap	Mapa clasificado con colores discretos para las clases.
interval	Leyenda basada en intervalos con rangos discretos.
none	No hay leyenda.

RenderOption

Objeto

Define los parámetros de visualización para representar datos en un mapa.

Nombre	Tipo	Valor predeterminado	Description
conditions	RenderOptionCondition[]		Una lista de condiciones de propiedad/valor que deben estar en el CQL de mosaico activo para que se habilite esta opción de representación
description	string		Una descripción más larga de la opción de renderizado que se puede utilizar para explicar su contenido.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Identificador único para la opción de renderización.
legend	RenderOptionLegend		Configuración de leyenda para esta opción de renderizado.
minZoom	integer (int32) maximum: 24	12	Nivel de zoom mínimo en el que se va a mostrar esta capa.
name	string maxLength: 40		Nombre descriptivo corto para la opción de renderización.
options	string		Una cadena codificada de cadena de consulta de URL de opciones de representación de TiTiler. Válido solo para `raster-tile` tipos. Ver Parámetros de consulta.
type	RenderOptionType	raster-tile	El tipo de representación en pantalla que se va a aplicar (ráster o vectorial).
vectorOptions	RenderOptionVectorOptions		Opciones para representar mosaicos vectoriales. Válido solo para `vt-polygon` y `vt-line` tipos.

RenderOptionCondition

Objeto

Define una condición para habilitar una opción de representación.

Nombre	Tipo	Description
property	string	Nombre de la propiedad que se va a comprobar en el filtro CQL activo.
value	string	Valor que debe ser igual la propiedad.

RenderOptionLegend

Objeto

Configuración para generar una leyenda de datos.

Nombre	Tipo	Description
labels	string[]	Etiquetas de texto para mostrar en la leyenda.
scaleFactor	number (float)	Un factor para multiplicar las etiquetas de leyenda de intervalo. Útil para rásteres a escala cuyas definiciones de mapa de colores se asignan a valores sin escala, mostrando de forma eficaz las etiquetas de leyenda como valores escalados.
trimEnd	integer (int32)	Número de elementos que se van a recortar desde el final de la leyenda.
trimStart	integer (int32)	El número de elementos que se van a recortar desde el principio de la definición de la leyenda. Se usa si hay valores importantes para la representación (por ejemplo, nodata) que no son deseables en la leyenda.
type	LegendConfigType	Tipo de leyenda que se va a crear, uno de los siguientes: `continuous`, `classmap`, `interval` o `none` (nota, `none` es un literal de cadena).

RenderOptionType

Enumeración

Especifica los tipos de opciones de renderizado para la visualización de mapas.

Valor	Description
raster-tile	Tipo de representación en pantalla de teselas ráster.
vt-polygon	Tipo de representación de polígono de mosaico vectorial.
vt-line	Tipo de representación de línea de mosaico vectorial.

RenderOptionVectorOptions

Objeto

Define los parámetros para la representación en teselas vectoriales.

Nombre	Tipo	Description
fillColor	string	Color de relleno para entidades poligonales.
filter	string[]	Expresión de filtro de MapBox GL para filtrar entidades.
sourceLayer	string	Nombre de la capa de origen en las teselas vectoriales.
strokeColor	string	Color de trazo para entidades de línea.
strokeWidth	integer (int32)	Ancho de los trazos de línea en píxeles.
tilejsonKey	string	Clave de recurso que contiene la dirección URL de TileJSON.

Compartir a través de

Stac Collection Render Options - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

OAuth2Auth

Ámbitos

Ejemplos

StacCollectionRenderOptions_Create

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions