@azure/maps-common package

Interfaces

BoundingBox	Cadre englobant
GeoJsonFeature	Fonctionnalité GeoJSON Un objet Feature représente un objet délimité spatialement. Chaque objet Feature est un objet GeoJSON. Référence
GeoJsonFeatureCollection	GeoJSON FeatureCollection. Référence
GeoJsonGeometryCollection	GeoJSON GeometryCollection. Référence
GeoJsonLineString	LineString GeoJSON. Référence
GeoJsonMultiLineString	GeoJSON MultiLineString. Référence
GeoJsonMultiPoint	GeoJSON MultiPoint. Référence
GeoJsonMultiPolygon	GeoJSON MultiPolygon. Référence
GeoJsonObject	Un objet GeoJSON représente une géométrie, une fonctionnalité ou une collection de caractéristiques. Référence
GeoJsonPoint	Point GeoJSON. Référence
GeoJsonPolygon	Polygone GeoJSON. Référence Pour spécifier une contrainte spécifique aux polygones, il est utile d’introduire le concept d’anneau linéaire : Un anneau linéaire est un LineString fermé avec quatre positions ou plus. Les première et dernière positions sont équivalentes et doivent contenir des valeurs identiques ; leur représentation DEVRAIT également être identique. Un anneau linéaire est la limite d’une surface ou la limite d’un trou dans une surface. Un anneau linéaire DOIT suivre la règle de la main droite en ce qui concerne la zone qu’il limite, c’est-à-dire que les anneaux extérieurs sont dans le sens inverse des aiguilles d’une montre et que les trous sont dans le sens des aiguilles d’une montre.

Alias de type

BBox	Cadre englobant comprenant des informations sur la plage de coordonnées pour ses géométries
BBox2D	Cadre englobant 2D
BBox3D	Cadre englobant 3D
GeoJsonGeometry	GeoJSON Geometry
GeoJsonType	Types GeoJSON
GeometryType	Type de géométries
LatLon	Paire latitude/longitude
Position	Tableau de nombres représentant un point
Position2D	Position 2D
Position3D	Position 3D

Functions

createAzureMapsKeyCredentialPolicy(KeyCredential)	Créer une stratégie de pipeline HTTP pour authentifier une requête à l’aide d’un AzureKeyCredential for Azure Maps
createMapsClientIdPolicy(string)	Créez une stratégie de pipeline HTTP pour ajouter l’en-tête x-ms-client-id pour TokenCredential l’authentification basée pour Azure Maps
createSendPollRequest<TOptions, TClient>({ client: TClient, options: TOptions, spec: OperationSpec })	Fonction d’assistance pour créer une méthode qui peut être passée à sendPollRequest dans createHttpPoller.
getRawResponse<TOptions, TResponse>((options: TOptions) => Promise<TResponse>, TOptions)	Extraire plusieurs champs de la réponse à rawResponse

Informations relatives à la fonction

createAzureMapsKeyCredentialPolicy(KeyCredential)

Créer une stratégie de pipeline HTTP pour authentifier une requête à l’aide d’un AzureKeyCredential for Azure Maps

function createAzureMapsKeyCredentialPolicy(azureKeyCredential: KeyCredential): PipelinePolicy

Paramètres

azureKeyCredential

KeyCredential

Retours

PipelinePolicy

createMapsClientIdPolicy(string)

Créez une stratégie de pipeline HTTP pour ajouter l’en-tête x-ms-client-id pour TokenCredential l’authentification basée pour Azure Maps

function createMapsClientIdPolicy(mapsClientId: string): PipelinePolicy

Paramètres

mapsClientId

string

Retours

PipelinePolicy

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

Fonction d’assistance pour créer une méthode qui peut être passée à sendPollRequest dans createHttpPoller.

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

Paramètres

settings

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

Paramètres de la demande d’interrogation, y compris le client, les options et les spécifications

Retours

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

Rappel qui accepte le chemin comme entrée et retourne la promesse de réponse Lro.

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

Extraire plusieurs champs de la réponse à rawResponse

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

Paramètres

getResponse

(options: TOptions) => Promise<TResponse>

Fonction asynchrone qui appelle en fait l’API back-end.

options

TOptions

Options du rappel getResponse

Retours

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

Promesse pour l’appel d’API.