@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 |
获取别名SourceUnion |
| IngestionStatus |
摄入状态 服务支持的已知值
准备:接受摄入并准备运行 |
| IngestionType |
摄入类型 服务支持的已知值
StaticCatalog:静态STAC目录 |
| LegendConfigType |
要创建的图例类型,以下之一: 服务支持的已知值
连续:连续色彩斜坡图例。 |
| MosaicMetadataType |
系统中的元数据资源类型 服务支持的已知值
马赛克:用于多个光栅资源马赛克的元数据 |
| NoDataType |
NoDataType 服务支持的已知值
Alpha:Nodata 由 alpha 通道表示 |
| NodeReadableStream |
为 ReadableStream 输入别名 Node.js。
在节点目标上,这会被解析为实际的NodeJS.ReadableStream类型。
在浏览器/React-native 目标上,平台变体解析为 |
| OperationStatus |
运营状况 服务支持的已知值
待处理:行动接受并准备执行 |
| PartitionTypeScheme |
定义用于临时数据组织的分区方案。 服务支持的已知值
年份:按年分区数据。 |
| PixelSelection |
选择支持的 TileMatrixSetId 之一的标识符(默认值:'WebMercatorQuad') 表示在从多个来源创建复合图像时,选择或计算像素的方法 服务支持的已知值
第一:从第一个可用图像中选择像素 |
| RenderOptionType |
指定地图可视化的渲染选项类型。 服务支持的已知值
栅格图块:栅格图块渲染类型。 |
| Resampling |
读取不同分辨率源栅格数据时使用的重采样算法 服务支持的已知值
最近:最近邻——选择最近像素值的最快方法 |
| SelMethod |
用于不精确匹配的Xarray索引方法 服务支持的已知值
最近法:最近邻法 |
| StacAssetUrlSigningMode |
表示资源URL的签名类型。 服务支持的已知值
true:在回复中签署资源网址。 |
| StacGetCollectionThumbnailResponse | |
| StacItemOrStacItemCollectionUnion |
StacItem或StacItemCollectionUnion的别名 |
| 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 Lambert共形圆锥投影瓦片矩阵集 |
| 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 |
表示资源URL的签名类型。 |
| 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>