RouteURL class

Un RouteURL représente une URL vers les opérations de routage Azure Maps.

Extends

Constructeurs

RouteURL(Pipeline, string)

Crée un instance de RouteURL.

Propriétés héritées

mapsUrl

Valeur de chaîne d’URL de base.

Méthodes

calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)

Retourne un itinéraire entre une origine et une destination, en passant par des waypoints s’ils sont spécifiés. L’itinéraire tiendra compte de facteurs tels que la circulation actuelle et les vitesses typiques de la route le jour de la semaine et l’heure de la journée demandés. Les informations retournées incluent la distance, le temps de trajet estimé et une représentation de la géométrie d’itinéraire. Des informations de routage supplémentaires telles que l’ordre de point de routage optimisé ou les instructions de tour par tour sont également disponibles, en fonction des options sélectionnées.

Le service de routage fournit un ensemble de paramètres pour une description détaillée du modèle de consommation spécifique au véhicule. Veuillez case activée modèle de consommation pour obtenir une explication détaillée des concepts et paramètres impliqués.

Si options.postBody est spécifié utilise l’API Post Route Directions : https://docs.microsoft.com/rest/api/maps/route/postroutedirections

Sinon, utilise l’API Get Route Directions : https://docs.microsoft.com/rest/api/maps/route/getroutedirections

calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

Remarque : Cette API est actuellement en préversion et peut être sujette à des modifications cassants. Calcule une matrice de résumés d’itinéraires pour un ensemble d’itinéraires définis par les emplacements d’origine et de destination. Pour chaque origine donnée, ce service calcule le coût du routage de cette origine vers chaque destination donnée. L’ensemble d’origines et l’ensemble de destinations peuvent être considérés comme les en-têtes de colonne et de ligne d’une table et chaque cellule de la table contient les coûts de routage de l’origine à la destination pour cette cellule. Pour chaque itinéraire, les temps de trajet et les distances sont calculés. Vous pouvez utiliser les coûts calculés pour déterminer les itinéraires à calculer à l’aide de l’API Itinéraires. Si le paramètre waitForResults dans la requête a la valeur false (valeur par défaut), cette API retourne un code de réponse 202 le long d’une URL de redirection dans le champ Emplacement de l’en-tête de réponse. Cette URL doit être vérifiée régulièrement jusqu’à ce que les données de réponse ou les informations d’erreur soient disponibles. La taille maximale d’une matrice pour cette API est 700 (le nombre d’origines multiplié par le nombre de destinations). Avec cette contrainte à l’esprit, des exemples de dimensions de matrice possibles sont : 50x10, 10x10, 28x25. 10x70 (il n’a pas besoin d’être carré).

Le calcul d’une matrice de routage est considéré comme une opération de longue durée. Une opération de longue durée implique qu’une fois la requête initiale acceptée (HTTP 202), le résultat final est interrogé jusqu’à ce qu’il soit disponible. Chaque demande de sondage redémarre le délai d’expiration de l’abandon, le cas échéant.

Utilise l’API Post Route Matrix : https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview

calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

Calculez un ensemble d’emplacements qui peuvent être atteints à partir du point d’origine en fonction du carburant, de l’énergie ou du budget de temps spécifié. Une limite de polygone (ou Isochrone) est retournée dans le sens inverse des aiguilles d’une montre, ainsi que dans le centre précis du polygone qui était le résultat du point d’origine. Le polygone retourné peut être utilisé pour un traitement ultérieur, tel que Recherche Inside Geometry pour rechercher des points d’ordre dans l’Isochrone fourni.

Utilise l’API Obtenir la plage d’itinéraires : https://docs.microsoft.com/rest/api/maps/route/getrouterange

Méthodes héritées

newPipeline(Credential, INewPipelineOptions)

Méthode statique utilisée pour créer un objet Pipeline avec les informations d’identification fournies.

Détails du constructeur

RouteURL(Pipeline, string)

Crée un instance de RouteURL.

new RouteURL(pipeline: Pipeline, mapsUrl?: string)

Paramètres

pipeline
Pipeline

Appelez MapsURL.newPipeline() pour créer un pipeline par défaut ou fournir un pipeline personnalisé.

mapsUrl

string

Chaîne d’URL pointant vers Azure Maps service, la valeur par défaut est "https://atlas.microsoft.com". Si aucun protocole n’est spécifié, par exemple "atlas.microsoft.com", il https sera supposé.

Détails de la propriété héritée

mapsUrl

Valeur de chaîne d’URL de base.

mapsUrl: string

Valeur de propriété

string

Hérité deMapsURL.mapsUrl

Détails de la méthode

calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)

Retourne un itinéraire entre une origine et une destination, en passant par des waypoints s’ils sont spécifiés. L’itinéraire tiendra compte de facteurs tels que la circulation actuelle et les vitesses typiques de la route le jour de la semaine et l’heure de la journée demandés. Les informations retournées incluent la distance, le temps de trajet estimé et une représentation de la géométrie d’itinéraire. Des informations de routage supplémentaires telles que l’ordre de point de routage optimisé ou les instructions de tour par tour sont également disponibles, en fonction des options sélectionnées.

Le service de routage fournit un ensemble de paramètres pour une description détaillée du modèle de consommation spécifique au véhicule. Veuillez case activée modèle de consommation pour obtenir une explication détaillée des concepts et paramètres impliqués.

Si options.postBody est spécifié utilise l’API Post Route Directions : https://docs.microsoft.com/rest/api/maps/route/postroutedirections

Sinon, utilise l’API Get Route Directions : https://docs.microsoft.com/rest/api/maps/route/getroutedirections

function calculateRouteDirections(aborter: Aborter, coordinates: GeoJSON.Position[], options?: CalculateRouteDirectionsOptions): Promise<CalculateRouteDirectionsResponse>

Paramètres

aborter
Aborter

Créez un instance Aborter avec Aborter.none ou Aborter.timeout(), accédez aux documents d’Aborter pour obtenir d’autres exemples d’annulation de demande.

coordinates

GeoJSON.Position[]

Tableau de coordonnées par lequel l’itinéraire est calculé. Chaque coordonnée est un tableau de [longitude, latitude]. Un minimum de deux coordonnées est requis. Le premier est l’origine et le dernier est la destination de l’itinéraire. Les coordonnées facultatives entre les deux agissent en tant que WayPoints dans l’itinéraire. Vous pouvez transmettre jusqu’à 150 WayPoints.

Retours

calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

Remarque : Cette API est actuellement en préversion et peut être sujette à des modifications cassants. Calcule une matrice de résumés d’itinéraires pour un ensemble d’itinéraires définis par les emplacements d’origine et de destination. Pour chaque origine donnée, ce service calcule le coût du routage de cette origine vers chaque destination donnée. L’ensemble d’origines et l’ensemble de destinations peuvent être considérés comme les en-têtes de colonne et de ligne d’une table et chaque cellule de la table contient les coûts de routage de l’origine à la destination pour cette cellule. Pour chaque itinéraire, les temps de trajet et les distances sont calculés. Vous pouvez utiliser les coûts calculés pour déterminer les itinéraires à calculer à l’aide de l’API Itinéraires. Si le paramètre waitForResults dans la requête a la valeur false (valeur par défaut), cette API retourne un code de réponse 202 le long d’une URL de redirection dans le champ Emplacement de l’en-tête de réponse. Cette URL doit être vérifiée régulièrement jusqu’à ce que les données de réponse ou les informations d’erreur soient disponibles. La taille maximale d’une matrice pour cette API est 700 (le nombre d’origines multiplié par le nombre de destinations). Avec cette contrainte à l’esprit, des exemples de dimensions de matrice possibles sont : 50x10, 10x10, 28x25. 10x70 (il n’a pas besoin d’être carré).

Le calcul d’une matrice de routage est considéré comme une opération de longue durée. Une opération de longue durée implique qu’une fois la requête initiale acceptée (HTTP 202), le résultat final est interrogé jusqu’à ce qu’il soit disponible. Chaque demande de sondage redémarre le délai d’expiration de l’abandon, le cas échéant.

Utilise l’API Post Route Matrix : https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview

function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>

Paramètres

aborter
Aborter

Créez une nouvelle instance Aborter avec Aborter.none ou Aborter.timeout(), accédez aux documents d’Aborter pour obtenir d’autres exemples d’annulation de demande.

body
CalculateRouteMatrixRequestBody

Matrice des coordonnées d’origine et de destination pour calculer la distance d’itinéraire, le temps de trajet et d’autres résumés pour chaque cellule de la matrice en fonction des paramètres d’entrée. Le nombre minimal et le nombre maximal de cellules pris en charge sont respectivement 1 et 700. Par exemple, il peut s’agir de 35 origines et 20 destinations ou de 25 origines et 25 destinations.

Retours

calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

Calculez un ensemble d’emplacements qui peuvent être atteints à partir du point d’origine en fonction du carburant, de l’énergie ou du budget de temps spécifié. Une limite de polygone (ou Isochrone) est retournée dans le sens inverse des aiguilles d’une montre, ainsi que dans le centre précis du polygone qui était le résultat du point d’origine. Le polygone retourné peut être utilisé pour un traitement ultérieur, tel que Recherche Inside Geometry pour rechercher des points d’ordre dans l’Isochrone fourni.

Utilise l’API Obtenir la plage d’itinéraires : https://docs.microsoft.com/rest/api/maps/route/getrouterange

function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>

Paramètres

aborter
Aborter

Créez une nouvelle instance Aborter avec Aborter.none ou Aborter.timeout(), accédez aux documents d’Aborter pour obtenir d’autres exemples d’annulation de demande.

center
GeoJSON.Position

Coordonnée à partir de laquelle le calcul de plage doit commencer.

Retours

Détails de la méthode héritée

newPipeline(Credential, INewPipelineOptions)

Méthode statique utilisée pour créer un objet Pipeline avec les informations d’identification fournies.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

Paramètres

credential
Credential

Comme SubscriptionKeyCredential, TokenCredential et MapControlCredential.

pipelineOptions
INewPipelineOptions

Retours

Nouvel objet Pipeline.

Hérité deMapsURL.newPipeline