@azure/maps-common package

參考

介面

BoundingBox	週框方塊
GeoJsonFeature	GeoJSON Feature A Feature 物件代表空間限定專案。每個 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 多邊形。參考若要指定 Polygons 特定的條件約束，引進線性環形的概念會很有用：線性環形是具有四個或多個位置的封閉 LineString。第一個和最後一個位置相等，而且必須包含相同的值;其標記法也應該相同。線性環形是表面的界限或介面中孔的界限。線性環形必須遵循相對於其界限區域的右手規則，亦即外部環形是逆時針的，而漏洞是順時針的。

類型別名

BBox	周框方塊，包括其幾何座標範圍的資訊
BBox2D	2D 周框方塊
BBox3D	3D 周框方塊
GeoJsonGeometry	GeoJSON 幾何
GeoJsonType	GeoJSON 類型
GeometryType	幾何類型
LatLon	緯度/經度配對
Position	代表點的數位陣列
Position2D	2D 位置
Position3D	3D 位置

函式

createAzureMapsKeyCredentialPolicy(KeyCredential)	使用 for Azure 地圖服務建立 HTTP 管線原則來驗證要求 `AzureKeyCredential`
createMapsClientIdPolicy(string)	建立 HTTP 管線原則，以新增 x-ms-client-id 標頭以進行 `TokenCredential` Azure 地圖服務
createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })	協助程式函式可建立方法，以傳遞至 createHttpPoller 中的 sendPollRequest。
getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)	擷取對 rawResponse 回應的數個欄位

函式詳細資料

createAzureMapsKeyCredentialPolicy(KeyCredential)

使用 for Azure 地圖服務建立 HTTP 管線原則來驗證要求 AzureKeyCredential

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

參數

azureKeyCredential: KeyCredential

傳回

PipelinePolicy

createMapsClientIdPolicy(string)

建立 HTTP 管線原則，以新增 x-ms-client-id 標頭以進行 TokenCredential Azure 地圖服務

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

參數

mapsClientId: string

傳回

PipelinePolicy

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 呼叫的承諾。

共用方式為