@azure/maps-common package

接口

BoundingBox	边界框
GeoJsonFeature	GeoJSON 特征 A 功能对象表示空间边界的东西。 每个 Feature 对象都是 GeoJSON 对象。 引用
GeoJsonFeatureCollection	GeoJSON FeatureCollection 中。 引用
GeoJsonGeometryCollection	GeoJSON GeometryCollection 的 GeoJSON Geometry集合。 引用
GeoJsonLineString	GeoJSON LineString 的 GeoJSON 行字符串。 引用
GeoJsonMultiLineString	GeoJSON MultiLineString 的 GeoJSON MultiLineString 中。 引用
GeoJsonMultiPoint	GeoJSON 多点。 引用
GeoJsonMultiPolygon	GeoJSON 多多边形。 引用
GeoJsonObject	GeoJSON 对象表示几何、特征或特征集合。 引用
GeoJsonPoint	GeoJSON 点。 引用
GeoJsonPolygon	GeoJSON 多边形。 引用 要指定特定于多边形的约束，引入线性环的概念很有用： 线性环是具有四个或更多位置的封闭 LineString。 第一个和最后一个位置是等价的，并且它们必须包含相同的值;它们的表示也应该相同。 线性环是曲面的边界或曲面中孔的边界。 线性环必须遵循其边界区域的右手定则，即外环逆时针，孔顺时针。

类型别名

BBox	边界框，包括有关其几何坐标范围的信息
BBox2D	2D 边界框
BBox3D	3D 边界框
GeoJsonGeometry	GeoJSON 几何图形
GeoJsonType	GeoJSON 类型
GeometryType	几何类型
LatLon	纬度/经度对
Position	表示点的数组
Position2D	2D 位置
Position3D	3D 位置

函数

createAzureMapsKeyCredentialPolicy(KeyCredential)	创建 HTTP 管道策略，以使用 AzureKeyCredential Azure Maps 的
createMapsClientIdPolicy(string)	创建 HTTP 管道策略，以添加 x-ms-client-id 标头，以便 TokenCredential 对 Azure Maps 进行基于身份验证
createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })	Helper 函数创建可传递给 createHttpPoller 中的 sendPollRequest 的方法。
getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)	提取对 rawResponse 的响应的多个字段

函数详细信息

createAzureMapsKeyCredentialPolicy(KeyCredential)

创建 HTTP 管道策略，以使用 AzureKeyCredential Azure Maps 的

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

参数

azureKeyCredential

KeyCredential

返回

PipelinePolicy

createMapsClientIdPolicy(string)

创建 HTTP 管道策略，以添加 x-ms-client-id 标头，以便 TokenCredential 对 Azure Maps 进行基于身份验证

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

参数

mapsClientId

string

返回

PipelinePolicy

createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })

Helper 函数创建可传递给 createHttpPoller 中的 sendPollRequest 的方法。

function createSendPollRequest<TOptions, TClient>(settings: { client: TClient, options: TOptions, spec: OperationSpec }): (path: string) => Promise<LroResponse<unknown>>

参数

settings

{ client: TClient, options: TOptions, spec: OperationSpec }

轮询请求的设置，包括客户端、选项和规范

返回

(path: string) => Promise<LroResponse<unknown>>

接受路径作为输入并返回 Lro 响应的承诺的回调。

getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)

提取对 rawResponse 的响应的多个字段

function getRawResponse<TOptions, TResponse>(getResponse: (options: TOptions) => Promise<TResponse>, options: TOptions): Promise<LroResponse<TResponse>>

参数

getResponse

(options: TOptions) => Promise<TResponse>

实际调用后端 API 的异步函数。

options

TOptions

getResponse 回调的选项

返回

Promise<@azure/core-lro.LroResponse<TResponse>>

API 调用的 Promise。