Partager via

@azure/maps-common package

Interfaces

BoundingBox

Cadre englobant
GeoJsonFeature

GeoJSON Feature Un objet Feature représente un objet spatialement délimité. Chaque objet Feature est un objet GeoJSON. Référence
GeoJsonFeatureCollection

GeoJSON FeatureCollection. Référence
GeoJsonGeometryCollection

GeoJSON GeometryCollection. Référence
GeoJsonLineString

GeoJSON LineString. 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 entité ou une collection d’entités. 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 la notion d’anneau linéaire :

  • Un anneau linéaire est une LineString fermée avec quatre positions ou plus.
  • La première et la dernière position sont équivalentes, et elles 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 par rapport à la zone qu’il délimite, c’est-à-dire que les anneaux extérieurs sont dans le sens inverse des aiguilles d’une montre et les trous dans le sens des aiguilles d’une montre.

Alias de type

BBox

Boîte englobante comprenant des informations sur la plage de coordonnées de ses géométries
BBox2D

Boîte englobante 2D
BBox3D

Boîte englobante 3D
GeoJsonGeometry

Géométrie GeoJSON
GeoJsonType

Types de 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éez une stratégie de pipeline HTTP pour authentifier une demande à l’aide d’un AzureKeyCredential pour 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 à la rawResponse

Informations relatives à la fonction

createAzureMapsKeyCredentialPolicy(KeyCredential)

Créez une stratégie de pipeline HTTP pour authentifier une demande à l’aide d’un AzureKeyCredential pour 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 }

Les paramètres de la demande de sondage, y compris le client, les options et la spécification

Retours

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

Un callback qui accepte le chemin en entrée et renvoie la promesse de la réponse Lro.

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

Extraire plusieurs champs de la réponse à la rawResponse

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

Paramètres

getResponse

(options: TOptions) => Promise<TResponse>

Une fonction asynchrone qui appelle en fait l’API backend.

options

TOptions

Les options pour le callback getResponse

Retours

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

Une promesse pour l’appel API.