Stac Collection Render Options - Create

服務:: Planetary Computer

API 版本:: 2025-04-30-preview

添加集合渲染選項
為給定集合添加渲染選項

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

URI 參數

名稱	位於	必要	類型	Description
collectionId	path	True	string maxLength: 500 pattern: .*	STAC 集合的唯一標識碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
id	True	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?	render 選項的唯一標識符。
name	True	string maxLength: 40	render 選項的簡短描述性名稱。
conditions		RenderOptionCondition[]	要啟用此渲染選項，必須位於活動馬賽克 CQL 中的屬性/值條件清單
description		string	對 render 選項的較長描述，可用於解釋其內容。
legend		RenderOptionLegend	此渲染選項的圖例配置。
minZoom		integer (int32) maximum: 24	顯示此圖層的最小縮放級別。
options		string	TiTiler 渲染選項的 URL 查詢字串編碼字串。僅對 `raster-tile` 類型有效。詳見查詢參數。
type		RenderOptionType	要應用的渲染類型（柵格或向量）。
vectorOptions		RenderOptionVectorOptions	用於渲染向量瓦片的選項。僅對 `vt-polygon` 和 `vt-line` 類型有效。

回應

名稱	類型	Description
201 Created	RenderOption	要求已成功，因此已建立新的資源。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。標題 x-ms-error-code: string

名稱

類型

Description

201 Created

RenderOption

要求已成功，因此已建立新的資源。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

未預期的錯誤回應。

標題

x-ms-error-code: string

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://geocatalog.spatio.azure.com/.default

範例

StacCollectionRenderOptions_Create

範例要求

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
}

範例回覆

狀態碼:: 201

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

定義

名稱	Description
Azure.Core.Foundations.Error	error 物件。
Azure.Core.Foundations.ErrorResponse	包含錯誤詳細數據的回應。
Azure.Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
LegendConfigType	要創建的圖例類型，以下之一： `continuous`、 `classmap`或 `intervalnone` （注意， `none` 是字串文字）。
RenderOption	定義用於在地圖上呈現數據的可視化參數。
RenderOptionCondition	定義啟用渲染選項的條件。
RenderOptionLegend	用於生成數據圖例的配置。
RenderOptionType	指定地圖可視化的渲染選項類型。
RenderOptionVectorOptions	定義向量瓦片渲染的參數。

Azure.Core.Foundations.Error

Object

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

Object

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

Object

物件，包含有關錯誤的更特定資訊。根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

LegendConfigType

列舉型別

要創建的圖例類型，以下之一： continuous、 classmap或 intervalnone （注意， none 是字串文字）。

值	Description
continuous	連續色帶圖例。
classmap	具有類離散顏色的分類地圖。
interval	具有離散範圍的基於間隔的圖例。
none	沒有圖例。

RenderOption

Object

定義用於在地圖上呈現數據的可視化參數。

名稱	類型	預設值	Description
conditions	RenderOptionCondition[]		要啟用此渲染選項，必須位於活動馬賽克 CQL 中的屬性/值條件清單
description	string		對 render 選項的較長描述，可用於解釋其內容。
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		render 選項的唯一標識符。
legend	RenderOptionLegend		此渲染選項的圖例配置。
minZoom	integer (int32) maximum: 24	12	顯示此圖層的最小縮放級別。
name	string maxLength: 40		render 選項的簡短描述性名稱。
options	string		TiTiler 渲染選項的 URL 查詢字串編碼字串。僅對 `raster-tile` 類型有效。詳見查詢參數。
type	RenderOptionType	raster-tile	要應用的渲染類型（柵格或向量）。
vectorOptions	RenderOptionVectorOptions		用於渲染向量瓦片的選項。僅對 `vt-polygon` 和 `vt-line` 類型有效。

RenderOptionCondition

Object

定義啟用渲染選項的條件。

名稱	類型	Description
property	string	要在活動 CQL 篩選器中籤入的屬性名稱。
value	string	屬性必須相等的值。

RenderOptionLegend

Object

用於生成數據圖例的配置。

名稱	類型	Description
labels	string[]	要在圖例上顯示的文本標籤。
scaleFactor	number (float)	間隔圖例標籤乘以的係數。對於色彩映射表定義映射到未縮放值的縮放柵格非常有用，可有效地將圖例標籤顯示為縮放值。
trimEnd	integer (int32)	要從圖例末尾修剪的項目數。
trimStart	integer (int32)	要從圖例定義的開頭開始修剪的項目數。如果存在對渲染很重要的值（例如 nodata），而圖例中不需要，則使用該值。
type	LegendConfigType	要創建的圖例類型，以下之一： `continuous`、 `classmap`或 `intervalnone` （注意， `none` 是字串文字）。

RenderOptionType

列舉型別

指定地圖可視化的渲染選項類型。

值	Description
raster-tile	柵格瓦片渲染類型。
vt-polygon	向量瓦片多邊形渲染類型。
vt-line	向量瓦片線渲染類型。

RenderOptionVectorOptions

Object

定義向量瓦片渲染的參數。

名稱	類型	Description
fillColor	string	面要素的填充顏色。
filter	string[]	用於篩選特徵的 MapBox GL 篩選表示式。
sourceLayer	string	向量圖塊中源層的名稱。
strokeColor	string	線條特徵的描邊顏色。
strokeWidth	integer (int32)	線條描邊的寬度（以像素為單位）。
tilejsonKey	string	包含 TileJSON URL 的 Asset key。

共用方式為

Stac Collection Render Options - Create

URI 參數

要求本文

回應

安全性

OAuth2Auth

範圍

範例

StacCollectionRenderOptions_Create

範例要求

範例回覆

定義

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions