Stac Collection Render Options - Create

Dienst:

Planetary Computer

API-Version:

2025-04-30-preview

Option zum Rendern von Sammlungen hinzufügen
Hinzufügen einer Renderoption für eine bestimmte Auflistung

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
collectionId	path	True	string maxLength: 500 pattern: .*	Eindeutige Kennung für die STAC-Sammlung.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-|_)[a-zA-Z0-9_-]*(?	Eindeutiger Bezeichner für die render-Option.
name	True	string maxLength: 40	Kurzer beschreibender Name für die Render-Option.
conditions		RenderOptionCondition[]	Eine Liste der Eigenschafts-/Wertbedingungen, die sich in der aktiven Mosaik-CQL befinden müssen, damit diese Renderoption aktiviert werden kann
description		string	Eine längere Beschreibung der Render-Option, die zur Erläuterung des Inhalts verwendet werden kann.
legend		RenderOptionLegend	Legendenkonfiguration für diese Renderoption.
minZoom		integer (int32) maximum: 24	Minimaler Zoomfaktor, bei dem dieser Layer angezeigt werden soll.
options		string	Eine URL-Abfragezeichenfolge, die mit TiTiler-Renderingoptionen codiert ist. Nur gültig für raster-tile Typen. Siehe Abfrageparameter.
type		RenderOptionType	Der Typ des anzuwendenden Renderings (Raster oder Vektor).
vectorOptions		RenderOptionVectorOptions	Optionen zum Rendern von Vektorkacheln. Gültig nur für vt-polygon und-Typen vt-line .

Antworten

Name	Typ	Beschreibung
201 Created	RenderOption	Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

Beispiele

StacCollectionRenderOptions_Create

Beispielanforderung

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
}

Beispiel für eine Antwort

Statuscode:

201

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors
LegendConfigType	Legendentyp, der erstellt werden soll: continuous, classmapoder intervalnone (Hinweis, none es handelt sich um ein Zeichenfolgenliteral).
RenderOption	Definiert Visualisierungsparameter für das Rendern von Daten auf einer Karte.
RenderOptionCondition	Definiert eine Bedingung für die Aktivierung einer Renderoption.
RenderOptionLegend	Konfiguration für die Generierung einer Datenlegende.
RenderOptionType	Gibt die Typen von Renderoptionen für die Kartenvisualisierung an.
RenderOptionVectorOptions	Definiert Parameter für das Rendern von Vektorkacheln.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine normal lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

LegendConfigType

Enumeration

Legendentyp, der erstellt werden soll: continuous, classmapoder intervalnone (Hinweis, none es handelt sich um ein Zeichenfolgenliteral).

Wert	Beschreibung
continuous	Legende für den fortlaufenden Farbverlauf.
classmap	Klassifizierte Karte mit diskreten Farben für Klassen.
interval	Intervallbasierte Legende mit diskreten Bereichen.
none	Keine Legende.

RenderOption

Objekt

Definiert Visualisierungsparameter für das Rendern von Daten auf einer Karte.

Name	Typ	Standardwert	Beschreibung
conditions	RenderOptionCondition[]		Eine Liste der Eigenschafts-/Wertbedingungen, die sich in der aktiven Mosaik-CQL befinden müssen, damit diese Renderoption aktiviert werden kann
description	string		Eine längere Beschreibung der Render-Option, die zur Erläuterung des Inhalts verwendet werden kann.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-|_)[a-zA-Z0-9_-]*(?		Eindeutiger Bezeichner für die render-Option.
legend	RenderOptionLegend		Legendenkonfiguration für diese Renderoption.
minZoom	integer (int32) maximum: 24	12	Minimaler Zoomfaktor, bei dem dieser Layer angezeigt werden soll.
name	string maxLength: 40		Kurzer beschreibender Name für die Render-Option.
options	string		Eine URL-Abfragezeichenfolge, die mit TiTiler-Renderingoptionen codiert ist. Nur gültig für raster-tile Typen. Siehe Abfrageparameter.
type	RenderOptionType	raster-tile	Der Typ des anzuwendenden Renderings (Raster oder Vektor).
vectorOptions	RenderOptionVectorOptions		Optionen zum Rendern von Vektorkacheln. Gültig nur für vt-polygon und-Typen vt-line .

RenderOptionCondition

Objekt

Definiert eine Bedingung für die Aktivierung einer Renderoption.

Name	Typ	Beschreibung
property	string	Name der Eigenschaft, die im aktiven CQL-Filter eingecheckt werden soll.
value	string	Wert, dem die Eigenschaft entsprechen muss.

RenderOptionLegend

Objekt

Konfiguration für die Generierung einer Datenlegende.

Name	Typ	Beschreibung
labels	string[]	Textbeschriftungen, die in der Legende angezeigt werden sollen.
scaleFactor	number (float)	Ein Faktor, mit dem Legendenbeschriftungen des Intervalls multipliziert werden sollen. Nützlich für skalierte Raster, deren Colormap-Definitionen nicht skalierten Werten zugeordnet sind, sodass Legendenbeschriftungen effektiv als skalierte Werte angezeigt werden.
trimEnd	integer (int32)	Anzahl der Elemente, die ab dem Ende der Legende gekürzt werden sollen.
trimStart	integer (int32)	Die Anzahl der Elemente, die ab dem Anfang der Legendendefinition gekürzt werden sollen. Wird verwendet, wenn es Werte gibt, die für das Rendern wichtig sind (z. B. nodata), die in der Legende nicht erwünscht sind.
type	LegendConfigType	Legendentyp, der erstellt werden soll: continuous, classmapoder intervalnone (Hinweis, none es handelt sich um ein Zeichenfolgenliteral).

RenderOptionType

Enumeration

Gibt die Typen von Renderoptionen für die Kartenvisualisierung an.

Wert	Beschreibung
raster-tile	Rendering-Typ für Raster-Kacheln.
vt-polygon	Rendering-Typ für Vektorkachel-Polygone.
vt-line	Rendering-Typ für Vektorkachellinien.

RenderOptionVectorOptions

Objekt

Definiert Parameter für das Rendern von Vektorkacheln.

Name	Typ	Beschreibung
fillColor	string	Füllfarbe für Polygon-Features.
filter	string[]	MapBox GL-Filterausdruck zum Filtern von Features.
sourceLayer	string	Name der Quellebene in den Vektorkacheln.
strokeColor	string	Strichfarbe für Linien-Features.
strokeWidth	integer (int32)	Breite der Linienstriche in Pixeln.
tilejsonKey	string	Asset-Schlüssel, der die TileJSON-URL enthält.