@azure/planetarycomputer package
インターフェイス
型エイリアス
| BandMetadataElement |
バンドメタデータ要素のユニオンタイプ |
| ColorMapNames |
データ可視化用の利用可能なカラーマップ サービスでサポートされている既知の値
アクセント:アクセントカラーマップ - 異なる色を持つ質的カラーマップ |
| 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 pgstac バックエンドで使用される cql2-json の追加に注意してくださいが、これは上記の仕様には含まれていません。 STAC API クエリでサポートされるフィルター言語を定義します。 サービスでサポートされている既知の値
cql-json:JSON形式の共通クエリ言語。 |
| GeometryType |
GeoJSONジオメトリの種類を表します。 サービスでサポートされている既知の値
ポイント:点の幾何学を表します。 |
| GeometryUnion |
GeometryUnionの別名 |
| IngestionSourceType |
インジェスションソースタイプ サービスでサポートされている既知の値
SasToken: Azure Blob Storage SAS token |
| IngestionSourceUnion |
IngestionSourceUnion の別名 |
| IngestionStatus |
摂取状況 サービスでサポートされている既知の値
準備完了:摂取が承認され、実行準備完了 |
| IngestionType |
摂取タイプ サービスでサポートされている既知の値
StaticCatalog:静的STACカタログ |
| LegendConfigType |
作成する凡例の種類: サービスでサポートされている既知の値
連続:連続したカラーランプの例。 |
| MosaicMetadataType |
システム内のメタデータリソースの種類 サービスでサポートされている既知の値
モザイク:複数のラスタアセットのモザイクのためのメタデータ |
| NoDataType |
NoDataType サービスでサポートされている既知の値
アルファ:アルファチャネルで表されるノーデータ |
| NodeReadableStream |
ReadableStream Node.js エイリアスをタイプしてください。
ノードターゲットでは、これは実際のNodeJS.ReadableStream型に解決されます。
ブラウザやreactネイティブ向けのプラットフォームバリアントは |
| OperationStatus |
運用状況 サービスでサポートされている既知の値
保留中:作戦受理、実行準備完了 |
| PartitionTypeScheme |
時間データ編成のパーティション分割スキームを定義します。 サービスでサポートされている既知の値
年:年ごとにデータを分割します。 |
| PixelSelection |
サポートされている TileMatrixSetId のいずれかを選択する識別子 (デフォルト: 'WebMercatorQuad') 複数のソースから合成を作成する際にピクセルを選択したり計算したりする方法を表しています サービスでサポートされている既知の値
まず:最初に利用可能な画像からピクセルを選択する |
| RenderOptionType |
マップ ビジュアリゼーションのレンダリング オプションの種類を指定します。 サービスでサポートされている既知の値
raster-tile:ラスタータイルレンダリングタイプ。 |
| Resampling |
異なる解像度でソースラスタデータを読む際に使うリサンプリングアルゴリズム サービスでサポートされている既知の値
最近近い方法:最近近傍 - 最も近いピクセル値を選択する最速の方法 |
| SelMethod |
不正確なマッチに使うXarrayインデックス手法 サービスでサポートされている既知の値
最近法:最近傍法 |
| StacAssetUrlSigningMode |
アセットURLの署名タイプを表現してください。 サービスでサポートされている既知の値
true: レスポンスでアセットURLに署名してください。 |
| StacGetCollectionThumbnailResponse | |
| StacItemOrStacItemCollectionUnion |
StacItemOrStacItemCollectionUnionの別名 |
| StacLinkType |
リンク用にMIMEタイプ。 サービスでサポートされている既知の値
image/tiff; application=geotiff: application=geotiff の画像/tiffを表します。 |
| StacModelType |
STACアイテムおよびコレクションタイプ用の列挙識別器。 サービスでサポートされている既知の値
機能:GeoJSON機能タイプ。 |
| StacQueryableDefinitionDataType |
queryables 拡張機能の queryable データ型。
これらは、Basic CQL2 でサポートされているデータ型です。 サービスでサポートされている既知の値
文字列:文字文字列。
例: 「これはリテラル文字列です。」 |
| StacSearchSortingDirection |
STAC API でのクエリ結果の並べ替え方向を定義します。 サービスでサポートされている既知の値
昇格:ソートは昇順になります。 |
| TerrainAlgorithm |
地形およびインデックスベース解析の対応アルゴリズム サービスでサポートされている既知の値
ヒルシェード:標高データからヒルシェードの可視化を作成します |
| TileAddressingScheme |
TileJSON仕様におけるタイルアドレッシングのスキーム サービスでサポートされている既知の値
xyz:左上に原点を記載したXYZタイルアドレス指定方式 |
| TileMatrixCornerOfOrigin |
タイル行列の角 (topLeft または bottomLeft) は、タイルの行と列に番号を付けるための原点として使用されます。 この角は、(0, 0) タイルの角でもあります。 サービスでサポートされている既知の値
topLeft:左上隅の原点(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 pgstac バックエンドで使用される cql2-json の追加に注意してくださいが、これは上記の仕様には含まれていません。 STAC API クエリでサポートされるフィルター言語を定義します。 |
| KnownGeometryType |
GeoJSONジオメトリの種類を表します。 |
| KnownIngestionSourceType |
インジェスションソースタイプ |
| KnownIngestionStatus |
インジェストの状態 |
| KnownIngestionType |
インジェストの種類 |
| KnownLegendConfigType |
作成する凡例の種類: |
| KnownMosaicMetadataType |
システム内のメタデータ・リソースのタイプ |
| KnownNoDataType |
NoDataType (ノーデータタイプ) |
| KnownOperationStatus |
操作の状態 |
| KnownPartitionTypeScheme |
時間データ編成のパーティション分割スキームを定義します。 |
| KnownPixelSelection |
サポートされている TileMatrixSetId のいずれかを選択する識別子 (デフォルト: 'WebMercatorQuad') 複数のソースから合成を作成する際にピクセルを選択したり計算したりする方法を表しています |
| KnownRenderOptionType |
マップ ビジュアリゼーションのレンダリング オプションの種類を指定します。 |
| KnownResampling |
異なる解像度でソース ラスター データを読み取るときに使用するリサンプリング アルゴリズム |
| KnownSelMethod |
不正確なマッチに使うXarrayインデックス手法 |
| KnownStacAssetUrlSigningMode |
アセットURLの署名タイプを表現してください。 |
| KnownStacLinkType |
リンク用にMIMEタイプ。 |
| KnownStacModelType |
STACアイテムおよびコレクションタイプ用の列挙識別器。 |
| KnownStacQueryableDefinitionDataType |
queryables 拡張機能の queryable データ型。 これらは、Basic CQL2 でサポートされているデータ型です。 |
| KnownStacSearchSortingDirection |
STAC API でのクエリ結果の並べ替え方向を定義します。 |
| KnownTerrainAlgorithm |
地形およびインデックスベースの解析でサポートされているアルゴリズム |
| 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>