RouteURL class

Paket:

azure-maps-rest

Eine RouteURL stellt eine URL zum Azure Maps Routenvorgängen dar.

Extends

MapsURL

Konstruktoren

RouteURL(Pipeline, string)

Erstellt eine instance von RouteURL.

Geerbte Eigenschaften

mapsUrl

Basis-URL-Zeichenfolgenwert.

Methoden

calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)	Gibt eine Route zwischen einem Ursprung und einem Ziel zurück, wobei Wegpunkte durchlaufen werden, sofern diese angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am angeforderten Wochentag und der gewünschten Tageszeit. Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Reisezeit und eine Darstellung der Routengeometrie. Abhängig von den ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Wegpunktreihenfolge oder Turn by Turn-Anweisungen zur Verfügung. Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung des fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um detaillierte Erläuterungen der betreffenden Konzepte und Parameter zu finden. Wenn options.postBody angegeben ist, verwendet die POST ROUTE DIRECTIONS-API: https://docs.microsoft.com/rest/api/maps/route/postroutedirections Verwendet andernfalls die API zum Abrufen von Routenbeschreibungen: https://docs.microsoft.com/rest/api/maps/route/getroutedirections
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)	Hinweis: Diese API befindet sich derzeit in der Vorschauphase und unterliegt möglicherweise Breaking Changes. Berechnet eine Matrix von Routenzusammenfassungen für eine Reihe von Routen, die durch Ursprungs- und Zielstandorte definiert sind. Für jeden bestimmten Ursprung berechnet dieser Dienst die Kosten für das Routing von diesem Ursprung zu jedem bestimmten Ziel. Der Satz der Ursprünge und der Zielsatz kann als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung zum Ziel für diese Zelle. Für jede Route werden die Fahrzeiten und Entfernungen berechnet. Sie können die berechneten Kosten verwenden, um zu bestimmen, welche Routen mit der Routingbeschreibungs-API berechnet werden sollen. Wenn der WaitForResults-Parameter in der Anforderung auf false (Standardwert) festgelegt ist, gibt diese API den Antwortcode 202 entlang einer Umleitungs-URL im Feld Location des Antwortheaders zurück. Diese URL sollte in regelmäßigen Abständen überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein). Das Berechnen einer Routenmatrix wird als lang andauernder Vorgang betrachtet. Bei vorgängen mit langer Ausführungsdauer wird das Endergebnis abgefragt, bis die anfängliche Anforderung akzeptiert wurde (HTTP 202). Jede Abfrageanforderung startet das Timeout des Abbruchs neu, sofern angegeben. Verwendet die Postroutenmatrix-API: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)	Berechnen Sie eine Reihe von Standorten, die vom Ursprungspunkt aus erreicht werden können, basierend auf dem angegebenen Brennstoff, Energie oder Zeitbudget. Eine Polygongrenze (oder Isochrone) wird in einer Ausrichtung gegen den Uhrzeigersinn sowie dem genauen Polygonmittelpunkt zurückgegeben, der das Ergebnis des Ursprungspunkts war. Das zurückgegebene Polygon kann für die weitere Verarbeitung verwendet werden, z. B. Search Inside Geometry, um innerhalb der bereitgestellten Isochrone nach POIs zu suchen. Verwendet die API zum Abrufen von Routenbereich: https://docs.microsoft.com/rest/api/maps/route/getrouterange

Geerbte Methoden

newPipeline(Credential, INewPipelineOptions)

Eine statische Methode zum Erstellen eines neuen Pipelineobjekts mit bereitgestellten Anmeldeinformationen.

Details zum Konstruktor

RouteURL(Pipeline, string)

Erstellt eine instance von RouteURL.

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

Parameter

pipeline

Pipeline

Rufen Sie MapsURL.newPipeline() auf, um eine Standardpipeline zu erstellen oder eine benutzerdefinierte Pipeline bereitzustellen.

mapsUrl

string

Eine URL-Zeichenfolge, die auf Azure Maps Dienst zeigt. Der Standardwert ist "https://atlas.microsoft.com". Wenn kein Protokoll angegeben wird, z. B. "atlas.microsoft.com", https wird angenommen.

Geerbte Eigenschaftsdetails

mapsUrl

Basis-URL-Zeichenfolgenwert.

mapsUrl: string

Eigenschaftswert

string

Geerbt vonMapsURL.mapsUrl

Details zur Methode

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

Gibt eine Route zwischen einem Ursprung und einem Ziel zurück, wobei Wegpunkte durchlaufen werden, sofern diese angegeben sind. Die Route berücksichtigt Faktoren wie den aktuellen Verkehr und die typischen Straßengeschwindigkeiten am angeforderten Wochentag und der gewünschten Tageszeit. Die zurückgegebenen Informationen umfassen die Entfernung, die geschätzte Reisezeit und eine Darstellung der Routengeometrie. Abhängig von den ausgewählten Optionen stehen auch zusätzliche Routinginformationen wie optimierte Wegpunktreihenfolge oder Turn by Turn-Anweisungen zur Verfügung.

Der Routingdienst bietet eine Reihe von Parametern für eine detaillierte Beschreibung des fahrzeugspezifischen Verbrauchsmodells. Überprüfen Sie das Verbrauchsmodell , um detaillierte Erläuterungen der betreffenden Konzepte und Parameter zu finden.

Wenn options.postBody angegeben ist, verwendet die POST ROUTE DIRECTIONS-API: https://docs.microsoft.com/rest/api/maps/route/postroutedirections

Verwendet andernfalls die API zum Abrufen von Routenbeschreibungen: https://docs.microsoft.com/rest/api/maps/route/getroutedirections

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

Parameter

aborter

Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

coordinates

GeoJSON.Position[]

Ein Array von Koordinaten, über das die Route berechnet wird. Jede Koordinate ist ein Array von [longitude, latitude]. Es sind mindestens zwei Koordinaten erforderlich. Der erste ist der Ursprung und der letzte das Ziel der Route. Optionale Koordinaten dazwischen fungieren als WayPoints in der Route. Sie können bis zu 150 WayPoints übergeben.

options

CalculateRouteDirectionsOptions

Gibt zurück

Promise<CalculateRouteDirectionsResponse>

calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

Hinweis: Diese API befindet sich derzeit in der Vorschauphase und unterliegt möglicherweise Breaking Changes. Berechnet eine Matrix von Routenzusammenfassungen für eine Reihe von Routen, die durch Ursprungs- und Zielstandorte definiert sind. Für jeden bestimmten Ursprung berechnet dieser Dienst die Kosten für das Routing von diesem Ursprung zu jedem bestimmten Ziel. Der Satz der Ursprünge und der Zielsatz kann als Spalten- und Zeilenüberschriften einer Tabelle betrachtet werden, und jede Zelle in der Tabelle enthält die Kosten für das Routing vom Ursprung zum Ziel für diese Zelle. Für jede Route werden die Fahrzeiten und Entfernungen berechnet. Sie können die berechneten Kosten verwenden, um zu bestimmen, welche Routen mit der Routingbeschreibungs-API berechnet werden sollen. Wenn der WaitForResults-Parameter in der Anforderung auf false (Standardwert) festgelegt ist, gibt diese API den Antwortcode 202 entlang einer Umleitungs-URL im Feld Location des Antwortheaders zurück. Diese URL sollte in regelmäßigen Abständen überprüft werden, bis die Antwortdaten oder Fehlerinformationen verfügbar sind. Die maximale Größe einer Matrix für diese API beträgt 700 (die Anzahl der Ursprünge multipliziert mit der Anzahl der Ziele). Unter Berücksichtigung dieser Einschränkung sind Beispiele für mögliche Matrixdimensionen: 50x10, 10x10, 28x25. 10x70 (es muss nicht quadratisch sein).

Das Berechnen einer Routenmatrix wird als lang andauernder Vorgang betrachtet. Bei vorgängen mit langer Ausführungsdauer wird das Endergebnis abgefragt, bis die anfängliche Anforderung akzeptiert wurde (HTTP 202). Jede Abfrageanforderung startet das Timeout des Abbruchs neu, sofern angegeben.

Verwendet die Postroutenmatrix-API: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview

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

Parameter

aborter

Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

body

CalculateRouteMatrixRequestBody

Die Matrix der Ursprungs- und Zielkoordinaten, um die Entfernung, die Reisezeit und andere Zusammenfassungen für jede Zelle der Matrix basierend auf den Eingabeparametern zu berechnen. Die minimale und die maximale Unterstützte Zellanzahl sind 1 bzw. 700. Es kann beispielsweise 35 Ursprünge und 20 Ziele oder 25 Ursprünge und 25 Ziele sein.

options

CalculateRouteMatrixOptions

Gibt zurück

Promise<CalculateRouteMatrixResponse>

calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

Berechnen Sie eine Reihe von Standorten, die vom Ursprungspunkt aus erreicht werden können, basierend auf dem angegebenen Brennstoff, Energie oder Zeitbudget. Eine Polygongrenze (oder Isochrone) wird in einer Ausrichtung gegen den Uhrzeigersinn sowie dem genauen Polygonmittelpunkt zurückgegeben, der das Ergebnis des Ursprungspunkts war. Das zurückgegebene Polygon kann für die weitere Verarbeitung verwendet werden, z. B. Search Inside Geometry, um innerhalb der bereitgestellten Isochrone nach POIs zu suchen.

Verwendet die API zum Abrufen von Routenbereich: https://docs.microsoft.com/rest/api/maps/route/getrouterange

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

Parameter

aborter

Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

center

GeoJSON.Position

Die Koordinate, ab der die Bereichsberechnung beginnen soll.

options

CalculateRouteRangeOptions

Gibt zurück

Promise<CalculateRouteRangeResponse>

Details zur geerbten Methode

newPipeline(Credential, INewPipelineOptions)

Eine statische Methode zum Erstellen eines neuen Pipelineobjekts mit bereitgestellten Anmeldeinformationen.

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

Parameter

credential

Credential

Beispielsweise SubscriptionKeyCredential, TokenCredential und MapControlCredential.

pipelineOptions

INewPipelineOptions

Gibt zurück

Pipeline

Ein neues Pipelineobjekt.

Geerbt vonMapsURL.newPipeline