你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/maps-common package

接口

BoundingBox

边界框

GeoJsonFeature

GeoJSON 特征 特征 对象表示空间边界对象。 每个 Feature 对象都是 GeoJSON 对象。 引用

GeoJsonFeatureCollection

GeoJSON FeatureCollection。 引用

GeoJsonGeometryCollection

GeoJSON GeometryCollection。 引用

GeoJsonLineString

GeoJSON LineString。 引用

GeoJsonMultiLineString

GeoJSON MultiLineString。 引用

GeoJsonMultiPoint

GeoJSON MultiPoint。 引用

GeoJsonMultiPolygon

GeoJSON MultiPolygon。 引用

GeoJsonObject

GeoJSON 对象表示一个 Geometry、Feature 或 Features 集合。 引用

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 for Azure Maps 对请求进行身份验证

createMapsClientIdPolicy(string)

创建 HTTP 管道策略以添加 x-ms-client-id 标头,用于TokenCredential基于 Azure Maps

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

帮助程序函数,用于创建可在 createHttpPoller 中传递给 sendPollRequest 的方法。

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

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

函数详细信息

createAzureMapsKeyCredentialPolicy(KeyCredential)

创建 HTTP 管道策略以使用 AzureKeyCredential for Azure Maps 对请求进行身份验证

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

参数

azureKeyCredential
KeyCredential

返回

createMapsClientIdPolicy(string)

创建 HTTP 管道策略以添加 x-ms-client-id 标头,用于TokenCredential基于 Azure Maps

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

参数

mapsClientId

string

返回

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

帮助程序函数,用于创建可在 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 调用的承诺。