RouteURL class
En RouteURL representerar en URL till Azure Maps routningsåtgärder.
- Extends
Konstruktorer
| RouteURL(Pipeline, string) | Skapar en instans av RouteURL. |
Ärvda egenskaper
| maps |
Bas-URL-strängvärde. |
Metoder
| calculate |
Returnerar en väg mellan ett ursprung och ett mål som passerar genom waypoints om de anges. Rutten tar hänsyn till faktorer som aktuell trafik och de typiska väghastigheterna på den begärda dagen i veckan och tiden på dagen. Information som returneras omfattar avståndet, den uppskattade restiden och en representation av ruttgeometrin. Ytterligare routningsinformation, till exempel optimerad waypointordning eller turordningsanvisningar, är också tillgänglig, beroende på vilka alternativ som valts. Routningstjänsten tillhandahåller en uppsättning parametrar för en detaljerad beskrivning av fordonsspecifik förbrukningsmodell. Se Förbrukningsmodell för detaljerad förklaring av de begrepp och parametrar som ingår. Om Annars används API:et Get Route Directions: https://docs.microsoft.com/rest/api/maps/route/getroutedirections |
| calculate |
Obs! Det här API:et är för närvarande i förhandsversion och kan vara föremål för icke-bakåtkompatibla ändringar. Beräknar en matris med routningssammanfattningar för en uppsättning vägar som definierats av ursprung och målplatser. För varje angivet ursprung beräknar den här tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Ursprungsuppsättningen och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. För varje rutt beräknas restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka vägar som ska beräknas med routningsriktnings-API:et. Om parametern waitForResults i begäran är inställd på false (standardvärde) returnerar det här API:et en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat). Att beräkna en routningsmatris anses vara en tidskrävande åtgärd. En tidskrävande åtgärd innebär att efter att den första begäran har accepterats (HTTP 202) avsöks slutresultatet tills det är tillgängligt. Varje avsökningsbegäran startar om tidsgränsen för avbruten, om en har angetts. Använder API:et För eftervägsmatris: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview |
| calculate |
Beräkna en uppsättning platser som kan nås från ursprungspunkten baserat på den bränsle-, energi- eller tidsbudget som anges. En polygongräns (eller Isochrone) returneras i en motsolsorientering samt det exakta polygoncentret som var resultatet av ursprungspunkten. Den returnerade polygonen kan användas för ytterligare bearbetning, till exempel Search Inside Geometry för att söka efter URI:er inom den angivna Isochronen. Använder API:et Hämta routningsintervall: https://docs.microsoft.com/rest/api/maps/route/getrouterange |
Ärvda metoder
| new |
En statisk metod som används för att skapa ett nytt pipelineobjekt med tillhandahållna autentiseringsuppgifter. |
Konstruktorinformation
RouteURL(Pipeline, string)
Skapar en instans av RouteURL.
new RouteURL(pipeline: Pipeline, mapsUrl?: string)Parametrar
- pipeline
- Pipeline
Anropa MapsURL.newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.
- mapsUrl
-
string
En URL-sträng som pekar på Azure Maps tjänst är "https://atlas.microsoft.com"standardvärdet .
Om inget protokoll anges, t.ex. "atlas.microsoft.com", antas det https .
Information om ärvda egenskaper
mapsUrl
Metodinformation
calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)
Returnerar en väg mellan ett ursprung och ett mål som passerar genom waypoints om de anges. Rutten tar hänsyn till faktorer som aktuell trafik och de typiska väghastigheterna på den begärda dagen i veckan och tiden på dagen. Information som returneras omfattar avståndet, den uppskattade restiden och en representation av ruttgeometrin. Ytterligare routningsinformation, till exempel optimerad waypointordning eller turordningsanvisningar, är också tillgänglig, beroende på vilka alternativ som valts.
Routningstjänsten tillhandahåller en uppsättning parametrar för en detaljerad beskrivning av fordonsspecifik förbrukningsmodell. Se Förbrukningsmodell för detaljerad förklaring av de begrepp och parametrar som ingår.
Om options.postBody anges använder API:et Post Route Directions: https://docs.microsoft.com/rest/api/maps/route/postroutedirections
Annars används API:et Get Route Directions: https://docs.microsoft.com/rest/api/maps/route/getroutedirections
function calculateRouteDirections(aborter: Aborter, coordinates: GeoJSON.Position[], options?: CalculateRouteDirectionsOptions): Promise<CalculateRouteDirectionsResponse>Parametrar
- aborter
- Aborter
Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran.
- coordinates
-
GeoJSON.Position[]
En matris med koordinater som vägen beräknas genom.
Varje koordinat är en matris med [longitude, latitude]. Minst två koordinater krävs.
Den första är ursprunget och det sista är vägens mål.
Valfria koordinater mellan fungerar som WayPoints i vägen. Du kan skicka upp till 150 WayPoints.
- options
- CalculateRouteDirectionsOptions
Returer
Promise<CalculateRouteDirectionsResponse>
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)
Obs! Det här API:et är för närvarande i förhandsversion och kan vara föremål för icke-bakåtkompatibla ändringar. Beräknar en matris med routningssammanfattningar för en uppsättning vägar som definierats av ursprung och målplatser. För varje angivet ursprung beräknar den här tjänsten kostnaden för routning från det ursprunget till varje angivet mål. Ursprungsuppsättningen och måluppsättningen kan betraktas som kolumn- och radrubriker i en tabell och varje cell i tabellen innehåller kostnaderna för routning från ursprunget till målet för cellen. För varje rutt beräknas restiderna och avstånden. Du kan använda de beräknade kostnaderna för att avgöra vilka vägar som ska beräknas med routningsriktnings-API:et. Om parametern waitForResults i begäran är inställd på false (standardvärde) returnerar det här API:et en 202-svarskod längs en omdirigerings-URL i fältet Plats i svarshuvudet. Den här URL:en bör kontrolleras regelbundet tills svarsdata eller felinformation är tillgänglig. Den maximala storleken på en matris för det här API:et är 700 (antalet ursprung multiplicerat med antalet mål). Med den begränsningen i åtanke är exempel på möjliga matrisdimensioner: 50x10, 10x10, 28x25. 10x70 (det behöver inte vara kvadrat).
Att beräkna en routningsmatris anses vara en tidskrävande åtgärd. En tidskrävande åtgärd innebär att efter att den första begäran har accepterats (HTTP 202) avsöks slutresultatet tills det är tillgängligt. Varje avsökningsbegäran startar om tidsgränsen för avbruten, om en har angetts.
Använder API:et För eftervägsmatris: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>Parametrar
- aborter
- Aborter
Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran.
Matrisen med ursprung och målkoordinater för att beräkna vägavstånd, restid och annan sammanfattning för varje cell i matrisen baserat på indataparametrarna. Det lägsta och högsta antalet celler som stöds är 1 respektive 700. Det kan till exempel vara 35 ursprung och 20 destinationer eller 25 ursprung och 25 destinationer.
- options
- CalculateRouteMatrixOptions
Returer
Promise<CalculateRouteMatrixResponse>
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)
Beräkna en uppsättning platser som kan nås från ursprungspunkten baserat på den bränsle-, energi- eller tidsbudget som anges. En polygongräns (eller Isochrone) returneras i en motsolsorientering samt det exakta polygoncentret som var resultatet av ursprungspunkten. Den returnerade polygonen kan användas för ytterligare bearbetning, till exempel Search Inside Geometry för att söka efter URI:er inom den angivna Isochronen.
Använder API:et Hämta routningsintervall: https://docs.microsoft.com/rest/api/maps/route/getrouterange
function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>Parametrar
- aborter
- Aborter
Skapa en ny Aborter-instans med Aborter.none eller Aborter.timeout(), goto-dokument för Aborter för fler exempel på annullering av begäran.
- center
- GeoJSON.Position
Koordinaten som intervallberäkningen ska starta från.
- options
- CalculateRouteRangeOptions
Returer
Promise<CalculateRouteRangeResponse>
Ärvd metodinformation
newPipeline(Credential, INewPipelineOptions)
En statisk metod som används för att skapa ett nytt pipelineobjekt med tillhandahållna autentiseringsuppgifter.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParametrar
- credential
- Credential
Till exempel SubscriptionKeyCredential, TokenCredential och MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Returer
Ett nytt pipelineobjekt.
Ärvd frånMapsURL.newPipeline