Stac Collection Render Options - Get

リファレンス

サービス:: Planetary Computer

API バージョン:: 2025-04-30-preview

コレクションレンダリングオプションを取得
特定のコレクションのレンダリングオプションを取得する

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/{collectionId}/configurations/render-options/{renderOptionId}?api-version=2025-04-30-preview

URI パラメーター

名前	/	必須	型	説明
collectionId	path	True	string maxLength: 500 pattern: .*	STAC コレクションの一意の識別子。
renderOptionId	path	True	string maxLength: 500 pattern: .*	レンダリングオプションの一意の識別子。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	RenderOption[]	要求は成功しました。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

RenderOption[]

要求は成功しました。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://geocatalog.spatio.azure.com/.default

例

StacCollectionRenderOptions_Get

要求のサンプル

HTTP

GET https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/stac/collections/sentinel-2-l2a-tutorial-7/configurations/render-options/a1007ec2-3ddc-4335-9edd-b1c26b1b4c92?api-version=2025-04-30-preview

応答のサンプル

状態コード:: 200

[
  {
    "id": "natural-color",
    "name": "Natural color",
    "description": "True color composite of visible bands (B04, B03, B02)",
    "type": "raster-tile",
    "options": "assets=B04&assets=B03&assets=B02&nodata=0&color_formula=Gamma RGB 3.2 Saturation 0.8 Sigmoidal RGB 25 0.35",
    "minZoom": 9
  },
  {
    "id": "natural-color-pre-feb-2022",
    "name": "Natural color (pre Feb, 2022)",
    "description": "Pre-Feb 2022 true color composite of visible bands (B04, B03, B02)",
    "type": "raster-tile",
    "options": "assets=B04&assets=B03&assets=B02&nodata=0&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
    "minZoom": 9
  },
  {
    "id": "color-infrared",
    "name": "Color infrared",
    "description": "Highlights healthy (red) and unhealthy (blue/gray) vegetation (B08, B04, B03).",
    "type": "raster-tile",
    "options": "assets=B08&assets=B04&assets=B03&nodata=0&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
    "minZoom": 9
  },
  {
    "id": "short-wave-infrared",
    "name": "Short wave infrared",
    "description": "Darker shades of green indicate denser vegetation. Brown is indicative of bare soil and built-up areas (B12, B8A, B04).",
    "type": "raster-tile",
    "options": "assets=B12&assets=B8A&assets=B04&nodata=0&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
    "minZoom": 9
  },
  {
    "id": "agriculture",
    "name": "Agriculture",
    "description": "Darker shades of green indicate denser vegetation (B11, B08, B02).",
    "type": "raster-tile",
    "options": "assets=B11&assets=B08&assets=B02&nodata=0&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
    "minZoom": 9
  },
  {
    "id": "normalized-difference-veg-inde",
    "name": "Normalized Difference Veg. Index (NDVI)",
    "description": "Normalized Difference Vegetation Index (B08-B04)/(B08+B04), darker green indicates healthier vegetation.",
    "type": "raster-tile",
    "options": "nodata=0&expression=(B08-B04)/(B08+B04)&rescale=-1,1&colormap_name=rdylgn&asset_as_band=true",
    "minZoom": 9
  },
  {
    "id": "moisture-index-ndwi",
    "name": "Moisture Index (NDWI)",
    "description": "Index indicating water stress in plants (B8A-B11)/(B8A+B11)",
    "type": "raster-tile",
    "options": "nodata=0&expression=(B8A-B11)/(B8A+B11)&rescale=-1,1&colormap_name=rdbu&asset_as_band=true",
    "minZoom": 9
  },
  {
    "id": "atmospheric-penetration",
    "name": "Atmospheric penetration",
    "description": "False color rendering with non-visible bands to reduce effects of atmospheric particles (B12, B11, B8A).",
    "type": "raster-tile",
    "options": "nodata=0&assets=B12&assets=B11&assets=B8A&color_formula=Gamma RGB 3.7 Saturation 1.5 Sigmoidal RGB 15 0.35",
    "minZoom": 9
  }
]

定義

名前	説明
Azure.Core.Foundations.Error	エラーオブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
LegendConfigType	作成する凡例の種類: `continuous`、 `classmap`、 `interval` 、または `none` のいずれか ( `none` は文字列リテラルであることに注意してください)。データ視覚化の凡例構成タイプを定義します。
RenderOption	マップ上にデータをレンダリングするための視覚化パラメーターを定義します。
RenderOptionCondition	レンダリングオプションを有効にするための条件を定義します。
RenderOptionLegend	データ凡例を生成するための構成。
RenderOptionType	マップビジュアリゼーションのレンダリングオプションの種類を指定します。
RenderOptionVectorOptions	ベクタータイルレンダリングのパラメーターを定義します。

Azure.Core.Foundations.Error

Object

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーについての、人間が判読できる文字列。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラーオブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

LegendConfigType

列挙

作成する凡例の種類: continuous、 classmap、 interval 、または none のいずれか ( none は文字列リテラルであることに注意してください)。データ視覚化の凡例構成タイプを定義します。

値	説明
classmap	クラスの個別の色を持つ分類済みマップ。
continuous	連続カラーランプの凡例。
interval	離散範囲を持つ間隔ベースの凡例。
none	伝説はありません。

RenderOption

Object

マップ上にデータをレンダリングするための視覚化パラメーターを定義します。

名前	型	規定値	説明
conditions	RenderOptionCondition[]		このレンダリング・オプションを有効にするためにアクティブ・モザイクCQLに含まれている必要があるプロパティ/値条件のリスト
description	string		レンダリングオプションの内容を説明するために使用できる詳細な説明。
id	string minLength: 1 maxLength: 30 pattern: ^(?!\-\|_)[a-zA-Z0-9_-]*(?		レンダリングオプションの一意の識別子。
legend	RenderOptionLegend		このレンダリングオプションの凡例設定。
minZoom	integer (int32) maximum: 24	12	このレイヤーを表示する最小ズームレベル。
name	string maxLength: 40		レンダリングオプションの短い説明名。
options	string		TiTiler レンダリングオプションの URL クエリ文字列でエンコードされた文字列。 `raster-tile`タイプにのみ有効です。「クエリパラメータ」を参照してください。 https://developmentseed.org/titiler/endpoints/cog/#description
type	RenderOptionType	raster-tile	適用するレンダリングのタイプ(ラスターまたはベクター)。
vectorOptions	RenderOptionVectorOptions		ベクタータイルをレンダリングするためのオプション。 `vt-polygon`タイプと`vt-line`タイプにのみ有効です。

RenderOptionCondition

Object

レンダリングオプションを有効にするための条件を定義します。

名前	型	説明
property	string	アクティブなCQLフィルターをチェックインするプロパティ名。
value	string	プロパティが等しくなければならない値。

RenderOptionLegend

Object

データ凡例を生成するための構成。

名前	型	説明
labels	string[]	凡例に表示するテキストラベル。
scaleFactor	number (float)	間隔の凡例ラベルに乗算する係数。カラーマップ定義がスケーリングされていない値にマッピングされるスケーリングされたラスターに役立ち、凡例ラベルをスケーリングされた値として効果的に表示します。
trimEnd	integer (int32)	凡例の末尾からトリミングする項目の数。
trimStart	integer (int32)	凡例定義の先頭からトリムする項目の数。レンダリングに重要な値 (nodata など) があり、凡例では望ましくない場合に使用されます。
type	LegendConfigType	作成する凡例の種類: `continuous`、 `classmap`、 `interval` 、または `none` のいずれか ( `none` は文字列リテラルであることに注意してください)。

RenderOptionType

列挙

マップビジュアリゼーションのレンダリングオプションの種類を指定します。

値	説明
raster-tile	ラスタータイルレンダリングタイプ。
vt-line	ベクタータイルラインレンダリングタイプ。
vt-polygon	ベクタータイルポリゴンのレンダリングタイプ。

RenderOptionVectorOptions

Object

ベクタータイルレンダリングのパラメーターを定義します。

名前	型	説明
fillColor	string	ポリゴンフィーチャの塗りつぶし色。
filter	string[]	MapBox GLフィルター式を使用して、フィーチャをフィルタリングします。
sourceLayer	string	ベクタータイル内のソースレイヤーの名前。
strokeColor	string	ラインの特徴のストロークの色。
strokeWidth	integer (int32)	線ストロークの幅 (ピクセル単位)。
tilejsonKey	string	TileJSON URL を含むアセットキー。

次の方法で共有

Stac Collection Render Options - Get

URI パラメーター

応答

セキュリティ

OAuth2Auth

スコープ

例

StacCollectionRenderOptions_Get

要求のサンプル

応答のサンプル

定義

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

LegendConfigType

RenderOption

RenderOptionCondition

RenderOptionLegend

RenderOptionType

RenderOptionVectorOptions