@azure/maps-common package

介面

BoundingBox	周框方塊
GeoJsonFeature	GeoJSON 特徵 特徵物件表示空間邊界的事物。 每個 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。