Udostępnij za pośrednictwem

RouteURL class

  • Odwołanie
Pakiet:
azure-maps-rest

Element RouteURL reprezentuje adres URL operacji routingu Azure Maps.

Extends
MapsURL

Konstruktory

RouteURL(Pipeline, string)

Tworzy wystąpienie elementu RouteURL.

Właściwości dziedziczone

mapsUrl

Wartość podstawowego ciągu adresu URL.

Metody

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

Zwraca trasę między źródłem a miejscem docelowym, przechodząc przez punkty waypoints, jeśli zostały określone. Trasa będzie uwzględniać czynniki, takie jak bieżący ruch i typowe prędkości drogowe w żądanym dniu tygodnia i o porze dnia. Zwrócone informacje obejmują odległość, szacowany czas podróży i reprezentację geometrii trasy. Dostępne są również dodatkowe informacje dotyczące routingu, takie jak zoptymalizowana kolejność punktów waypoint lub instrukcje kolei w zależności od wybranych opcji.

Usługa routingu udostępnia zestaw parametrów dla szczegółowego opisu modelu zużycia specyficznego dla pojazdu. Aby uzyskać szczegółowe wyjaśnienie pojęć i parametrów, zapoznaj się z modelem zużycia .

Jeśli options.postBody określono, używa interfejsu API Post Route Directions: https://docs.microsoft.com/rest/api/maps/route/postroutedirections

W przeciwnym razie używa interfejsu API Get Route Directions: https://docs.microsoft.com/rest/api/maps/route/getroutedirections
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

Uwaga: ten interfejs API jest obecnie w wersji zapoznawczej i może podlegać zmianom powodujących niezgodność. Oblicza macierz podsumowań tras dla zestawu tras zdefiniowanych przez lokalizacje początkowe i docelowe. Dla każdego danego źródła ta usługa oblicza koszt routingu od tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu od źródła do miejsca docelowego dla tej komórki. Dla każdej trasy obliczane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które trasy mają być obliczane przy użyciu interfejsu API Routing Directions. Jeśli parametr waitForResults w żądaniu ma wartość false (wartość domyślna), ten interfejs API zwraca kod odpowiedzi 202 wzdłuż adresu URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).

Obliczanie macierzy tras jest uznawane za długotrwałą operację. Długotrwałe operacje oznaczają, że po zaakceptowaniu początkowego żądania (HTTP 202) wynik końcowy zostanie sondowany do momentu udostępnienia. Każde żądanie sondowania ponownie uruchamia limit czasu przerwania, jeśli został określony.

Używa interfejsu API macierzy tras post: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

Oblicz zestaw lokalizacji, które można uzyskać z punktu początkowego na podstawie określonego budżetu paliwa, energii lub czasu. Granica wielokąta (lub Isochrone) jest zwracana w orientacji odwrotnej do ruchu wskazówek zegara, a także dokładnego środka wielokąta, który był wynikiem punktu początkowego. Zwrócony wielokąt może służyć do dalszego przetwarzania, takiego jak Search Wewnątrz Geometrii, aby wyszukać interfejsy POI w ramach dostarczonego isochrone.

Używa interfejsu API pobierania zakresu tras: https://docs.microsoft.com/rest/api/maps/route/getrouterange

Metody dziedziczone

newPipeline(Credential, INewPipelineOptions)

Metoda statyczna użyta do utworzenia nowego obiektu Pipeline z podanym poświadczenie.

Szczegóły konstruktora

RouteURL(Pipeline, string)

Tworzy wystąpienie elementu RouteURL.

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

Parametry

pipeline
Pipeline

Wywołaj metodę MapsURL.newPipeline(), aby utworzyć potok domyślny, lub podaj dostosowany potok.

mapsUrl

string

Ciąg adresu URL wskazujący usługę Azure Maps, wartość domyślna to "https://atlas.microsoft.com". Jeśli protokół nie zostanie określony, np. "atlas.microsoft.com", https zostanie przyjęty.

Szczegóły właściwości dziedziczonej

mapsUrl

Wartość podstawowego ciągu adresu URL.

mapsUrl: string

Wartość właściwości

string

Dziedziczone zbiblioteki MapsURL.mapsUrl

Szczegóły metody

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

Zwraca trasę między źródłem a miejscem docelowym, przechodząc przez punkty waypoints, jeśli zostały określone. Trasa będzie uwzględniać czynniki, takie jak bieżący ruch i typowe prędkości drogowe w żądanym dniu tygodnia i o porze dnia. Zwrócone informacje obejmują odległość, szacowany czas podróży i reprezentację geometrii trasy. Dostępne są również dodatkowe informacje dotyczące routingu, takie jak zoptymalizowana kolejność punktów waypoint lub instrukcje kolei w zależności od wybranych opcji.

Usługa routingu udostępnia zestaw parametrów dla szczegółowego opisu modelu zużycia specyficznego dla pojazdu. Aby uzyskać szczegółowe wyjaśnienie pojęć i parametrów, zapoznaj się z modelem zużycia .

Jeśli options.postBody określono, używa interfejsu API Post Route Directions: https://docs.microsoft.com/rest/api/maps/route/postroutedirections

W przeciwnym razie używa interfejsu API Get Route Directions: https://docs.microsoft.com/rest/api/maps/route/getroutedirections

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

coordinates

GeoJSON.Position[]

Tablica współrzędnych, za pomocą których jest obliczana trasa. Każda współrzędna jest tablicą .[longitude, latitude] Wymagana jest co najmniej dwie współrzędne. Pierwszy jest źródłem, a ostatni to miejsce docelowe trasy. Opcjonalne współrzędne między działają jako punkty WayPoint w trasie. Możesz przekazać maksymalnie 150 punktów WayPoint.

options
CalculateRouteDirectionsOptions

Zwraca

Promise<CalculateRouteDirectionsResponse>

calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)

Uwaga: ten interfejs API jest obecnie w wersji zapoznawczej i może podlegać zmianom powodujących niezgodność. Oblicza macierz podsumowań tras dla zestawu tras zdefiniowanych przez lokalizacje początkowe i docelowe. Dla każdego danego źródła ta usługa oblicza koszt routingu od tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu od źródła do miejsca docelowego dla tej komórki. Dla każdej trasy obliczane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które trasy mają być obliczane przy użyciu interfejsu API Routing Directions. Jeśli parametr waitForResults w żądaniu ma wartość false (wartość domyślna), ten interfejs API zwraca kod odpowiedzi 202 wzdłuż adresu URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).

Obliczanie macierzy tras jest uznawane za długotrwałą operację. Długotrwałe operacje oznaczają, że po zaakceptowaniu początkowego żądania (HTTP 202) wynik końcowy zostanie sondowany do momentu udostępnienia. Każde żądanie sondowania ponownie uruchamia limit czasu przerwania, jeśli został określony.

Używa interfejsu API macierzy tras post: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

body
CalculateRouteMatrixRequestBody

Macierz współrzędnych pochodzenia i miejsca docelowego w celu obliczenia odległości trasy, czasu podróży i innego podsumowania dla każdej komórki macierzy na podstawie parametrów wejściowych. Minimalna i maksymalna obsługiwana liczba komórek to odpowiednio 1 i 700. Na przykład może to być 35 źródeł i 20 miejsc docelowych lub 25 źródeł i 25 miejsc docelowych.

options
CalculateRouteMatrixOptions

Zwraca

Promise<CalculateRouteMatrixResponse>

calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)

Oblicz zestaw lokalizacji, które można uzyskać z punktu początkowego na podstawie określonego budżetu paliwa, energii lub czasu. Granica wielokąta (lub Isochrone) jest zwracana w orientacji odwrotnej do ruchu wskazówek zegara, a także dokładnego środka wielokąta, który był wynikiem punktu początkowego. Zwrócony wielokąt może służyć do dalszego przetwarzania, takiego jak Search Wewnątrz Geometrii, aby wyszukać interfejsy POI w ramach dostarczonego isochrone.

Używa interfejsu API pobierania zakresu tras: https://docs.microsoft.com/rest/api/maps/route/getrouterange

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

Parametry

aborter
Aborter

Utwórz nowe wystąpienie Aborter z elementem Aborter.none lub Aborter.timeout(), aby uzyskać więcej przykładów dotyczących anulowania żądania.

center
GeoJSON.Position

Współrzędna, z której ma zostać uruchomione obliczenie zakresu.

options
CalculateRouteRangeOptions

Zwraca

Promise<CalculateRouteRangeResponse>

Szczegóły metody dziedziczonej

newPipeline(Credential, INewPipelineOptions)

Metoda statyczna użyta do utworzenia nowego obiektu Pipeline z podanym poświadczenie.

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

Parametry

credential
Credential

Na przykład SubscriptionKeyCredential, TokenCredential i MapControlCredential.

pipelineOptions
INewPipelineOptions

Zwraca

Pipeline

Nowy obiekt Pipeline.

Dziedziczone zMapsURL.newPipeline