@azure/planetarycomputer package
介面
類型別名
| BandMetadataElement |
頻段元資料元素的聯合型別 |
| ColorMapNames |
可用於資料視覺化的彩色地圖 服務支援的已知值
口音:Accent 色彩映射 - 具有明顯顏色的質性色彩映射 |
| ContinuablePage |
描述結果頁面的介面。 |
| DataCropCollectionFeatureByFormatResponse | |
| DataCropCollectionFeatureResponse | |
| DataCropCollectionFeatureWidthByHeightResponse | |
| DataCropFeatureByFormatResponse | |
| DataCropFeatureResponse | |
| DataCropFeatureWidthByHeightResponse | |
| DataCropSearchFeatureByFormatResponse | |
| DataCropSearchFeatureResponse | |
| DataCropSearchFeatureWidthByHeightResponse | |
| DataGetCollectionAssetsForBboxResponse | |
| DataGetCollectionAssetsForTileNoTmsResponse | |
| DataGetCollectionBboxCropResponse | |
| DataGetCollectionBboxCropWithDimensionsResponse | |
| DataGetCollectionTileByFormatResponse | |
| DataGetCollectionTileByScaleAndFormatResponse | |
| DataGetCollectionTileByScaleResponse | |
| DataGetCollectionTileNoTmsByFormatResponse | |
| DataGetCollectionTileNoTmsByScaleAndFormatResponse | |
| DataGetCollectionTileNoTmsByScaleResponse | |
| DataGetCollectionTileNoTmsResponse | |
| DataGetCollectionTileResponse | |
| DataGetCollectionWmtsCapabilitiesByTmsResponse | |
| DataGetCollectionWmtsCapabilitiesResponse | |
| DataGetIntervalLegendResponse | |
| DataGetItemAvailableAssetsResponse | |
| DataGetItemBboxCropResponse | |
| DataGetItemBboxCropWithDimensionsResponse | |
| DataGetItemPreviewResponse | |
| DataGetItemPreviewWithFormatResponse | |
| DataGetItemWmtsCapabilitiesByTmsResponse | |
| DataGetItemWmtsCapabilitiesResponse | |
| DataGetLegendResponse | |
| DataGetSearchAssetsForTileNoTmsResponse | |
| DataGetSearchBboxAssetsResponse | |
| DataGetSearchBboxCropResponse | |
| DataGetSearchBboxCropWithDimensionsResponse | |
| DataGetSearchTileByFormatResponse | |
| DataGetSearchTileByScaleAndFormatResponse | |
| DataGetSearchTileByScaleResponse | |
| DataGetSearchTileNoTmsByFormatResponse | |
| DataGetSearchTileNoTmsByScaleAndFormatResponse | |
| DataGetSearchTileNoTmsByScaleResponse | |
| DataGetSearchTileNoTmsResponse | |
| DataGetSearchTileResponse | |
| DataGetSearchWmtsCapabilitiesByTmsResponse | |
| DataGetSearchWmtsCapabilitiesResponse | |
| DataGetTileByFormatResponse | |
| DataGetTileByScaleAndFormatResponse | |
| DataGetTileByScaleResponse | |
| DataGetTileMatricesResponse | |
| DataGetTileNoTmsByFormatResponse | |
| DataGetTileNoTmsByScaleAndFormatResponse | |
| DataGetTileNoTmsByScaleResponse | |
| DataGetTileNoTmsResponse | |
| DataGetTileResponse | |
| FeatureType |
GeoJSON 特徵物件的類型識別碼 服務支援的已知值功能:標準 GeoJSON 功能類型識別碼 |
| FileContents |
二進位檔內容的有效值。 |
| FilterLanguage |
POST 請求中的 filter-lang 值選項。 根據 https://github.com/stac-api-extensions/filter#queryables 請注意添加了 cql2-json,它由 pgstac 後端使用,但未包含在上面的規範中。 定義 STAC API 查詢支援的篩選條件語言。 服務支援的已知值
cql-json:常見的 JSON 格式查詢語言。 |
| GeometryType |
代表 GeoJSON 幾何的類型。 服務支援的已知值
點:代表點幾何形狀。 |
| GeometryUnion |
GeometryUnion 的別名 |
| IngestionSourceType |
擷取來源類型 服務支援的已知值
SasToken: Azure Blob 儲存體 SAS token |
| IngestionSourceUnion |
用於輸入的別名來源 Union。 |
| IngestionStatus |
攝取狀況 服務支援的已知值
準備:已接受攝取並準備執行 |
| IngestionType |
攝取類型 服務支援的已知值
StaticCatalog:靜態 STAC 目錄 |
| LegendConfigType |
要創建的圖例類型,以下之一: 服務支援的已知值
連續:連續色彩斜坡圖例。 |
| MosaicMetadataType |
系統中元資料資源類型 服務支援的已知值
馬賽克:多重點陣資產馬賽克的元資料 |
| NoDataType |
NoDataType 服務支援的已知值
Alpha:Nodata 以 alpha 通道表示 |
| NodeReadableStream |
輸入別名 Node.js ReadableStream。
在節點目標上,這會解析成實際的 NodeJS.ReadableStream 類型。
在瀏覽器/react-native 目標上,平台變體會解析為 |
| OperationStatus |
營運狀況 服務支援的已知值
待定:行動已接受並準備執行 |
| PartitionTypeScheme |
定義用於臨時數據組織的分區方案。 服務支援的已知值
年份:按年分區資料。 |
| PixelSelection |
選擇支援的 TileMatrixSetId 之一的識別碼(預設值:'WebMercatorQuad') 代表在從多個來源建立合成影像時,選擇或計算像素的方法 服務支援的已知值
第一:從第一個可用的影像中選取像素 |
| RenderOptionType |
指定地圖可視化的渲染選項類型。 服務支援的已知值
點陣圖塊:點陣圖塊渲染類型。 |
| Resampling |
用於在不同解析度下讀取原始光柵資料時使用的重取樣演算法 服務支援的已知值
最近:最近鄰——選擇最接近像素值的最快方法 |
| SelMethod |
用於不精確匹配的 Xarray 索引方法 服務支援的已知值
最近法:最近鄰法 |
| StacAssetUrlSigningMode |
表示資產網址的簽章類型。 服務支援的已知值
true: 在回應中簽署資產網址。 |
| StacGetCollectionThumbnailResponse | |
| StacItemOrStacItemCollectionUnion |
StacItemOrStacItemCollectionUnion 的別名 |
| StacLinkType |
連結的MIME類型。 服務支援的已知值
image/tiff; application=geotiff:代表帶有 application=geotiff 的影像/tiff。 |
| StacModelType |
STAC項目與收藏類型的枚舉判別器。 服務支援的已知值
功能:GeoJSON 功能類型。 |
| StacQueryableDefinitionDataType |
queryables 擴展的可查詢數據類型。
這些是 Basic CQL2 支援的數據類型。 服務支援的已知值
字串:字串。
示例:“This is a literal string.” |
| StacSearchSortingDirection |
定義 STAC API 中查詢結果的排序方向。 服務支援的已知值
上升:排序會依升序排列。 |
| TerrainAlgorithm |
支援的地形與索引分析演算法 服務支援的已知值
Hillshade:從海拔資料建立Hillshade視覺化 |
| TileAddressingScheme |
TileJSON 規範中的磁磚位址方案 服務支援的已知值
xyz:XYZ 圖塊位址方案,原點位於左上角 |
| TileMatrixCornerOfOrigin |
平鋪矩陣的角(topLeft 或 bottomLeft)用作對平鋪行和列進行編號的原點。 這個角也是 (0, 0) 圖塊的一個角。 服務支援的已知值
左上角:左上角的原點(Y 向下遞增) |
| TileMatrixSetId |
選擇支援的 TileMatrixSetId 之一的識別碼(預設值:'WebMercatorQuad') 用於服務地圖磚的座標參考系統與鋪磚方案的標準識別碼 服務支援的已知值
CanadianNAD83_LCC:加拿大NAD83蘭伯特共形圓錐投影圖塊矩陣集 |
| TilerImageFormat |
圖塊與影像請求的影像格式指定器 服務支援的已知值
png:可攜式網路圖形格式-支援透明度 |
| WarpKernelResampling |
用於重投影時使用的 WarpKernel 重取樣演算法。 預設為 服務支援的已知值
最近:最近鄰 |
列舉
| KnownColorMapNames |
用於數據可視化的可用彩色圖 |
| KnownFeatureType |
GeoJSON 特徵物件的類型識別碼 |
| KnownFilterLanguage |
POST 請求中的 filter-lang 值選項。 根據 https://github.com/stac-api-extensions/filter#queryables 請注意添加了 cql2-json,它由 pgstac 後端使用,但未包含在上面的規範中。 定義 STAC API 查詢支援的篩選條件語言。 |
| KnownGeometryType |
代表 GeoJSON 幾何的類型。 |
| KnownIngestionSourceType |
擷取來源類型 |
| KnownIngestionStatus |
攝取狀態 |
| KnownIngestionType |
擷取類型 |
| KnownLegendConfigType |
要創建的圖例類型,以下之一: |
| KnownMosaicMetadataType |
系統中元數據資源的類型 |
| KnownNoDataType |
NoDataType |
| KnownOperationStatus |
作業狀態 |
| KnownPartitionTypeScheme |
定義用於臨時數據組織的分區方案。 |
| KnownPixelSelection |
選擇支援的 TileMatrixSetId 之一的識別碼(預設值:'WebMercatorQuad') 代表在從多個來源建立合成影像時,選擇或計算像素的方法 |
| KnownRenderOptionType |
指定地圖可視化的渲染選項類型。 |
| KnownResampling |
以不同解析度讀取源柵格數據時使用的重採樣演算法 |
| KnownSelMethod |
用於不精確匹配的 Xarray 索引方法 |
| KnownStacAssetUrlSigningMode |
表示資產網址的簽章類型。 |
| KnownStacLinkType |
連結的MIME類型。 |
| KnownStacModelType |
STAC項目與收藏類型的枚舉判別器。 |
| KnownStacQueryableDefinitionDataType |
queryables 擴展的可查詢數據類型。 這些是 Basic CQL2 支援的數據類型。 |
| KnownStacSearchSortingDirection |
定義 STAC API 中查詢結果的排序方向。 |
| KnownTerrainAlgorithm |
基於 terrain 和索引的分析支持的演算法 |
| KnownTileAddressingScheme |
TileJSON 規範中的瓦片尋址方案 |
| KnownTileMatrixCornerOfOrigin |
平鋪矩陣的角(topLeft 或 bottomLeft)用作對平鋪行和列進行編號的原點。 這個角也是 (0, 0) 圖塊的一個角。 |
| KnownTileMatrixSetId |
選擇支援的 TileMatrixSetId 之一的識別碼(預設值:'WebMercatorQuad') 用於服務地圖磚的座標參考系統與鋪磚方案的標準識別碼 |
| KnownTilerImageFormat |
磁貼和圖像請求的圖像格式說明符 |
| KnownVersions |
代表版本資訊。 |
| KnownWarpKernelResampling |
用於重投影時使用的 WarpKernel 重取樣演算法。 預設為 |
函式
| is |
RestError 的 Typeguard |
| restore |
從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器,或在原始輪詢器不在範圍內之後建構投票器時,這非常有用。 |
變數
| Rest |
失敗管線要求的自定義錯誤類型。 |
函式詳細資料
isRestError(unknown)
RestError 的 Typeguard
function isRestError(e: unknown): e
參數
- e
-
unknown
catch 子句攔截到的東西。
傳回
e
restorePoller<TResponse, TResult>(PlanetaryComputerProClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器,或在原始輪詢器不在範圍內之後建構投票器時,這非常有用。
function restorePoller<TResponse, TResult>(client: PlanetaryComputerProClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
參數
- client
- PlanetaryComputerProClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
傳回
PollerLike<OperationState<TResult>, TResult>