Stac Collection Render Options - Create

Tjänst:: Planetary Computer

API-version:: 2026-04-15

Lägg till alternativ för samlingsrendering
Lägga till ett renderingsalternativ för en viss samling

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Unik identifierare för STAC-samlingen.
endpoint	path	True	string (uri)	GeoCatalog-endpoint, t.ex. `https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com`
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Unik identifierare för återgivningsalternativet.
name	True	string maxLength: 40	Kort beskrivande namn för renderingsalternativet.
conditions		RenderOptionCondition[]	En lista över egenskaps-/värdevillkor som måste finnas i den aktiva mosaik-CQL för att det här renderingsalternativet ska aktiveras
description		string	En längre beskrivning av renderingsalternativet som kan användas för att förklara dess innehåll.
legend		RenderOptionLegend	Förklaringskonfiguration för det här renderingsalternativet.
minZoom		integer (int32) maximum: 24	Minsta zoomnivå som det här lagret ska visas på.
options		string	En URL-frågesträngskodad sträng med TiTiler-återgivningsalternativ. Gäller endast för `raster-tile` typer. Se Frågeparametrar.
type		RenderOptionType	Den typ av återgivning som ska användas (raster eller vektor).
vectorOptions		RenderOptionVectorOptions	Alternativ för återgivning av vektorpaneler. Gäller endast för `vt-polygon` och `vt-line` typer.

Svar

Name	Typ	Description
201 Created	RenderOption	Begäran har slutförts och en ny resurs har skapats som ett resultat.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

201 Created

RenderOption

Begäran har slutförts och en ny resurs har skapats som ett resultat.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

StacCollectionRenderOptions_Create

Exempelbegäran

HTTP

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
}

Exempelsvar

Statuskod:: 201

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

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.
LegendConfigType	Förklaringstyp som ska göras, en av: `continuous`, `classmap`, `interval` eller `none` (observera `none` att det är en strängliteral).
RenderOption	Definierar visualiseringsparametrar för återgivning av data på en karta.
RenderOptionCondition	Definierar ett villkor för att aktivera ett återgivningsalternativ.
RenderOptionLegend	Konfiguration för att generera en dataförklaring.
RenderOptionType	Anger typerna av återgivningsalternativ för kartvisualisering.
RenderOptionVectorOptions	Definierar parametrar för återgivning av vektorpaneler.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

LegendConfigType

Uppräkning

Förklaringstyp som ska göras, en av: continuous, classmap, interval eller none (observera none att det är en strängliteral).

Värde	Description
continuous	Förklaring av kontinuerlig färgramp.
classmap	Klassificerad karta med diskreta färger för klasser.
interval	Intervallbaserad förklaring med diskreta intervall.
none	Ingen legend.

RenderOption

Objekt

Definierar visualiseringsparametrar för återgivning av data på en karta.

Name	Typ	Standardvärde	Description
conditions	RenderOptionCondition[]		En lista över egenskaps-/värdevillkor som måste finnas i den aktiva mosaik-CQL för att det här renderingsalternativet ska aktiveras
description	string		En längre beskrivning av renderingsalternativet som kan användas för att förklara dess innehåll.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Unik identifierare för återgivningsalternativet.
legend	RenderOptionLegend		Förklaringskonfiguration för det här renderingsalternativet.
minZoom	integer (int32) maximum: 24	12	Minsta zoomnivå som det här lagret ska visas på.
name	string maxLength: 40		Kort beskrivande namn för renderingsalternativet.
options	string		En URL-frågesträngskodad sträng med TiTiler-återgivningsalternativ. Gäller endast för `raster-tile` typer. Se Frågeparametrar.
type	RenderOptionType	raster-tile	Den typ av återgivning som ska användas (raster eller vektor).
vectorOptions	RenderOptionVectorOptions		Alternativ för återgivning av vektorpaneler. Gäller endast för `vt-polygon` och `vt-line` typer.

RenderOptionCondition

Objekt

Definierar ett villkor för att aktivera ett återgivningsalternativ.

Name	Typ	Description
property	string	Egenskapsnamn för att kontrollera det aktiva CQL-filtret.
value	string	Värde som egenskapen måste vara lika med.

RenderOptionLegend

Objekt

Konfiguration för att generera en dataförklaring.

Name	Typ	Description
labels	string[]	Textetiketter som ska visas i förklaringen.
scaleFactor	number (float)	En faktor för att multiplicera etiketter för intervallförklaring med. Användbart för skalade raster vars färgmappningsdefinitioner mappas till oskalade värden, vilket effektivt visar förklaringsetiketter som skalade värden.
trimEnd	integer (int32)	Antal objekt som ska trimmas från slutet av förklaringen.
trimStart	integer (int32)	Antalet objekt som ska trimmas från början av förklaringsdefinitionen. Används om det finns värden som är viktiga för återgivning (t.ex. nodata) som inte är önskvärda i förklaringen.
type	LegendConfigType	Förklaringstyp som ska göras, en av: `continuous`, `classmap`, `interval` eller `none` (observera `none` att det är en strängliteral).

RenderOptionType

Uppräkning

Anger typerna av återgivningsalternativ för kartvisualisering.

Värde	Description
raster-tile	Återgivningstyp för rasterruta.
vt-polygon	Återgivningstyp för vektorpanelpolygon.
vt-line	Återgivningstyp för vektorpanellinje.

RenderOptionVectorOptions

Objekt

Definierar parametrar för återgivning av vektorpaneler.

Name	Typ	Description
fillColor	string	Fyllningsfärg för polygonfunktioner.
filter	string[]	MapBox GL filtrera uttryck för att filtrera funktioner.
sourceLayer	string	Namnet på källskiktet i vektorpanelerna.
strokeColor	string	Linjefärg för linjefunktioner.
strokeWidth	integer (int32)	Bredden på linjelinjer i pixlar.
tilejsonKey	string	Tillgångsnyckel som innehåller TileJSON-URL:en.