Stac Collection Render Options - Create

Usługa:: Planetary Computer

Wersja API:: 2025-04-30-preview

Dodaj opcję renderowania kolekcji
Dodawanie opcji renderowania dla danej kolekcji

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
collectionId	path	True	string maxLength: 500 pattern: .*	Niepowtarzalny identyfikator kolekcji STAC.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Ciało żądania

Nazwa	Wymagane	Typ	Opis
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Unikatowy identyfikator opcji renderowania.
name	True	string maxLength: 40	Krótka opisowa nazwa opcji renderowania.
conditions		RenderOptionCondition[]	Lista warunków właściwości/wartości, które muszą znajdować się w aktywnym CQL mozaiki, aby ta opcja renderowania była włączona
description		string	Dłuższy opis opcji renderowania, który może być użyty do wyjaśnienia jej zawartości.
legend		RenderOptionLegend	Konfiguracja legendy dla tej opcji renderowania.
minZoom		integer (int32) maximum: 24	Minimalny poziom powiększenia, przy którym ma być wyświetlana ta warstwa.
options		string	Ciąg zakodowany w ciągu zapytania URL z opcjami renderowania TiTiler. Dotyczy tylko `raster-tile` typów. Zobacz Parametry zapytania.
type		RenderOptionType	Typ renderingu, który ma zostać zastosowany (rastrowy lub wektorowy).
vectorOptions		RenderOptionVectorOptions	Opcje renderowania kafli wektorowych. Dotyczy tylko typów `vt-polygon` i `vt-line` typów.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	RenderOption	Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

201 Created

RenderOption

Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

OAuth2Auth

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

Zakresów

Nazwa	Opis
https://geocatalog.spatio.azure.com/.default

Przykłady

StacCollectionRenderOptions_Create

Przykładowa prośba

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
}

Przykładowa odpowiedź

Kod statusu:: 201

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

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
LegendConfigType	Typ legendy do utworzenia, jeden z: `continuous`, `classmap`, `interval` lub `none` (uwaga, `none` jest literałem ciągu).
RenderOption	Definiuje parametry wizualizacji do renderowania danych na mapie.
RenderOptionCondition	Określa warunek włączenia opcji renderowania.
RenderOptionLegend	Konfiguracja generowania legendy danych.
RenderOptionType	Określa typy opcji renderowania dla wizualizacji mapy.
RenderOptionVectorOptions	Definiuje parametry renderowania kafli wektorowych.

Azure.Core.Foundations.Error

Sprzeciwiać się

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Sprzeciwiać się

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Sprzeciwiać się

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

LegendConfigType

Wyliczenie

Typ legendy do utworzenia, jeden z: continuous, classmap, interval lub none (uwaga, none jest literałem ciągu).

Wartość	Opis
continuous	Ciągła legenda skali barw.
classmap	Sklasyfikowana mapa z dyskretnymi kolorami dla klas.
interval	Legenda oparta na interwałach z dyskretnymi zakresami.
none	Bez legendy.

RenderOption

Sprzeciwiać się

Definiuje parametry wizualizacji do renderowania danych na mapie.

Nazwa	Typ	Wartość domyślna	Opis
conditions	RenderOptionCondition[]		Lista warunków właściwości/wartości, które muszą znajdować się w aktywnym CQL mozaiki, aby ta opcja renderowania była włączona
description	string		Dłuższy opis opcji renderowania, który może być użyty do wyjaśnienia jej zawartości.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Unikatowy identyfikator opcji renderowania.
legend	RenderOptionLegend		Konfiguracja legendy dla tej opcji renderowania.
minZoom	integer (int32) maximum: 24	12	Minimalny poziom powiększenia, przy którym ma być wyświetlana ta warstwa.
name	string maxLength: 40		Krótka opisowa nazwa opcji renderowania.
options	string		Ciąg zakodowany w ciągu zapytania URL z opcjami renderowania TiTiler. Dotyczy tylko `raster-tile` typów. Zobacz Parametry zapytania.
type	RenderOptionType	raster-tile	Typ renderingu, który ma zostać zastosowany (rastrowy lub wektorowy).
vectorOptions	RenderOptionVectorOptions		Opcje renderowania kafli wektorowych. Dotyczy tylko typów `vt-polygon` i `vt-line` typów.

RenderOptionCondition

Sprzeciwiać się

Określa warunek włączenia opcji renderowania.

Nazwa	Typ	Opis
property	string	Nazwa właściwości do zaewidencjonowania w aktywnym filtrze CQL.
value	string	Wartość, która musi być równa właściwości.

RenderOptionLegend

Sprzeciwiać się

Konfiguracja generowania legendy danych.

Nazwa	Typ	Opis
labels	string[]	Etykiety tekstowe do wyświetlenia w legendzie.
scaleFactor	number (float)	Współczynnik mnożony przez etykiety legendy interwałów. Przydatne w przypadku skalowanych rastrów, których definicje map kolorów są odwzorowywane na wartości nieskalowane, co efektywnie pokazuje etykiety legendy jako wartości skalowane.
trimEnd	integer (int32)	Liczba elementów do przycięcia od końca legendy.
trimStart	integer (int32)	Liczba elementów do przycięcia od początku definicji legendy. Używane, jeśli istnieją wartości ważne dla renderowania (np. nodata), które nie są pożądane w legendzie.
type	LegendConfigType	Typ legendy do utworzenia, jeden z: `continuous`, `classmap`, `interval` lub `none` (uwaga, `none` jest literałem ciągu).

RenderOptionType

Wyliczenie

Określa typy opcji renderowania dla wizualizacji mapy.

Wartość	Opis
raster-tile	Typ renderowania kafelków rastrowych.
vt-polygon	Typ renderowania wielokąta kafelka wektorowego.
vt-line	Typ renderowania linii kafelków wektorowych.

RenderOptionVectorOptions

Sprzeciwiać się

Definiuje parametry renderowania kafli wektorowych.

Nazwa	Typ	Opis
fillColor	string	Kolor wypełnienia dla obiektów poligonowych.
filter	string[]	Wyrażenie filtru MapBox GL do filtrowania obiektów.
sourceLayer	string	Nazwa warstwy źródłowej w kaflach wektorowych.
strokeColor	string	Kolor obrysu dla obiektów liniowych.
strokeWidth	integer (int32)	Szerokość obrysów linii w pikselach.
tilejsonKey	string	Klucz zasobu zawierający adres URL tileJSON.

Udostępnij za pośrednictwem

Stac Collection Render Options - Create

Parametry URI

Ciało żądania

Odpowiedzi

Zabezpieczenia

OAuth2Auth

Zakresów

Przykłady

StacCollectionRenderOptions_Create

Przykładowa prośba

Przykładowa odpowiedź

Definicje

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions