Stac Collection Render Options - Create

Layanan:: Planetary Computer

Versi API:: 2025-04-30-preview

Tambahkan Opsi Render Koleksi
Menambahkan opsi render untuk koleksi tertentu

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
collectionId	path	True	string maxLength: 500 pattern: .*	Pengidentifikasi unik untuk koleksi STAC.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	Pengidentifikasi unik untuk opsi render.
name	True	string maxLength: 40	Nama deskriptif pendek untuk opsi render.
conditions		RenderOptionCondition[]	Daftar kondisi properti/nilai yang harus ada di CQL mosaik aktif agar opsi render ini diaktifkan
description		string	Deskripsi yang lebih panjang tentang opsi render yang dapat digunakan untuk menjelaskan kontennya.
legend		RenderOptionLegend	Konfigurasi legenda untuk opsi render ini.
minZoom		integer (int32) maximum: 24	Tingkat zoom minimum untuk menampilkan layer ini.
options		string	String yang dikodekan string kueri URL dari opsi rendering TiTiTiler. Hanya berlaku untuk `raster-tile` jenis. Lihat Parameter Kueri.
type		RenderOptionType	Jenis rendering yang akan diterapkan (raster atau vektor).
vectorOptions		RenderOptionVectorOptions	Opsi untuk merender ubin vektor. Hanya berlaku untuk `vt-polygon` dan `vt-line` jenis.

Respons

Nama	Jenis	Deskripsi
201 Created	RenderOption	Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

201 Created

RenderOption

Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Respons kesalahan tak terduga.

Header

x-ms-error-code: string

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://geocatalog.spatio.azure.com/.default

Contoh

StacCollectionRenderOptions_Create

Permintaan sampel

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
}

Respon sampel

Kode status:: 201

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

Definisi

Nama	Deskripsi
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
LegendConfigType	Jenis legenda yang akan dibuat, salah satunya: `continuous`, `classmap`, atau `intervalnone` (catatan, `none` adalah literal string).
RenderOption	Menentukan parameter visualisasi untuk merender data pada peta.
RenderOptionCondition	Menentukan kondisi untuk mengaktifkan opsi render.
RenderOptionLegend	Konfigurasi untuk menghasilkan legenda data.
RenderOptionType	Menentukan jenis opsi render untuk visualisasi peta.
RenderOptionVectorOptions	Menentukan parameter untuk rendering petak peta vektor.

Azure.Core.Foundations.Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

LegendConfigType

Enumerasi

Jenis legenda yang akan dibuat, salah satunya: continuous, classmap, atau intervalnone (catatan, none adalah literal string).

Nilai	Deskripsi
continuous	Legenda ramp warna terus menerus.
classmap	Peta rahasia dengan warna diskrit untuk kelas.
interval	Legenda berbasis interval dengan rentang diskrit.
none	Tidak ada legenda.

RenderOption

Objek

Menentukan parameter visualisasi untuk merender data pada peta.

Nama	Jenis	Nilai default	Deskripsi
conditions	RenderOptionCondition[]		Daftar kondisi properti/nilai yang harus ada di CQL mosaik aktif agar opsi render ini diaktifkan
description	string		Deskripsi yang lebih panjang tentang opsi render yang dapat digunakan untuk menjelaskan kontennya.
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		Pengidentifikasi unik untuk opsi render.
legend	RenderOptionLegend		Konfigurasi legenda untuk opsi render ini.
minZoom	integer (int32) maximum: 24	12	Tingkat zoom minimum untuk menampilkan layer ini.
name	string maxLength: 40		Nama deskriptif pendek untuk opsi render.
options	string		String yang dikodekan string kueri URL dari opsi rendering TiTiTiler. Hanya berlaku untuk `raster-tile` jenis. Lihat Parameter Kueri.
type	RenderOptionType	raster-tile	Jenis rendering yang akan diterapkan (raster atau vektor).
vectorOptions	RenderOptionVectorOptions		Opsi untuk merender ubin vektor. Hanya berlaku untuk `vt-polygon` dan `vt-line` jenis.

RenderOptionCondition

Objek

Menentukan kondisi untuk mengaktifkan opsi render.

Nama	Jenis	Deskripsi
property	string	Nama properti untuk memeriksa filter CQL aktif.
value	string	Nilai yang harus sama dengan properti.

RenderOptionLegend

Objek

Konfigurasi untuk menghasilkan legenda data.

Nama	Jenis	Deskripsi
labels	string[]	Label teks untuk ditampilkan pada legenda.
scaleFactor	number (float)	Faktor untuk mengalikan label legenda interval dengan. Berguna untuk raster berskala yang definisi peta warnanya dipetakan ke nilai yang tidak diskalakan, secara efektif menampilkan label legenda sebagai nilai yang diskalakan.
trimEnd	integer (int32)	Jumlah item yang akan dipangkas dari akhir legenda.
trimStart	integer (int32)	Jumlah item yang akan dipangkas dari awal definisi legenda. Digunakan jika ada nilai penting untuk rendering (misalnya nodata) yang tidak diinginkan dalam legenda.
type	LegendConfigType	Jenis legenda yang akan dibuat, salah satunya: `continuous`, `classmap`, atau `intervalnone` (catatan, `none` adalah literal string).

RenderOptionType

Enumerasi

Menentukan jenis opsi render untuk visualisasi peta.

Nilai	Deskripsi
raster-tile	Jenis rendering ubin raster.
vt-polygon	Jenis rendering poligon ubin vektor.
vt-line	Jenis rendering garis ubin vektor.

RenderOptionVectorOptions

Objek

Menentukan parameter untuk rendering petak peta vektor.

Nama	Jenis	Deskripsi
fillColor	string	Isi warna untuk fitur poligon.
filter	string[]	Ekspresi filter MapBox GL untuk memfilter fitur.
sourceLayer	string	Nama layer sumber dalam ubin vektor.
strokeColor	string	Warna goresan untuk fitur garis.
strokeWidth	integer (int32)	Lebar goresan garis dalam piksel.
tilejsonKey	string	Kunci aset yang berisi URL TileJSON.

Bagikan melalui

Stac Collection Render Options - Create

Parameter URI

Isi Permintaan

Respons

Keamanan

OAuth2Auth

Cakupan

Contoh

StacCollectionRenderOptions_Create

Permintaan sampel

Respon sampel

Definisi

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions