@azure/maps-common package

Gränssnitt

BoundingBox	Avgränsningsruta
GeoJsonFeature	GeoJSON-funktion Ett funktionsobjekt representerar en rumsligt avgränsad sak. Varje funktionsobjekt är ett GeoJSON-objekt. Referens
GeoJsonFeatureCollection	GeoJSON FeatureCollection. Referens
GeoJsonGeometryCollection	GeoJSON GeometryCollection. Referens
GeoJsonLineString	GeoJSON LineString. Referens
GeoJsonMultiLineString	GeoJSON MultiLineString. Referens
GeoJsonMultiPoint	GeoJSON MultiPoint. Referens
GeoJsonMultiPolygon	GeoJSON MultiPolygon. Referens
GeoJsonObject	Ett GeoJSON-objekt representerar en geometri, en funktion eller en samling funktioner. Referens
GeoJsonPoint	GeoJSON-punkt. Referens
GeoJsonPolygon	GeoJSON-polygon. Referens För att ange en begränsning som är specifik för polygoner är det användbart att introducera begreppet linjär ring: En linjär ring är en sluten LineString med fyra eller fler positioner. Den första och sista positionen är likvärdiga, och de MÅSTE innehålla identiska värden; deras representation BÖR också vara identisk. En linjär ring är gränsen för en yta eller gränsen för ett hål i en yta. En linjär ring MÅSTE följa högerregeln med avseende på den area den avgränsar, dvs. yttre ringar är moturs och hålen är medurs.

Typalias

BBox	Begränsningsram med information om koordinatområdet för dess geometrier
BBox2D	2D-avgränsningsruta
BBox3D	3D-avgränsningsruta
GeoJsonGeometry	GeoJSON-geometri
GeoJsonType	GeoJSON-typer
GeometryType	Typer av geometri
LatLon	Par för latitud/longitud
Position	En matris med tal som representerar en punkt
Position2D	2D-position
Position3D	3D-position

Funktioner

createAzureMapsKeyCredentialPolicy(KeyCredential)	Skapa en HTTP-pipelineprincip för att autentisera en begäran med hjälp av en AzureKeyCredential för Azure Maps
createMapsClientIdPolicy(string)	Skapa en HTTP-pipelineprincip för att lägga till x-ms-client-id huvud för TokenCredential baserad autentisering för Azure Maps
createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })	Hjälpfunktion för att skapa en metod som kan skickas till sendPollRequest i createHttpPoller.
getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)	Extrahera flera fält i svaret på rawResponse

Funktionsinformation

createAzureMapsKeyCredentialPolicy(KeyCredential)

Skapa en HTTP-pipelineprincip för att autentisera en begäran med hjälp av en AzureKeyCredential för Azure Maps

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

Parametrar

azureKeyCredential

KeyCredential

Returer

PipelinePolicy

createMapsClientIdPolicy(string)

Skapa en HTTP-pipelineprincip för att lägga till x-ms-client-id huvud för TokenCredential baserad autentisering för Azure Maps

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

Parametrar

mapsClientId

string

Returer

PipelinePolicy

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

Hjälpfunktion för att skapa en metod som kan skickas till sendPollRequest i createHttpPoller.

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

Parametrar

settings

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

Inställningarna för omröstningsbegäran, inklusive klient, alternativ och specifikationer

Returer

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

Ett återanrop som accepterar sökvägen som indata och returnerar löftet om Lro-svar.

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

Extrahera flera fält i svaret på rawResponse

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

Parametrar

getResponse

(options: TOptions) => Promise<TResponse>

En asynkron funktion som faktiskt anropar serverdels-API:et.

options

TOptions

Alternativen för återanrop getResponse

Returer

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

Ett löfte för API-anropet.