RouteURL class
Een RouteURL vertegenwoordigt een URL naar de Azure Maps routebewerkingen.
- Extends
Constructors
| RouteURL(Pipeline, string) | Hiermee maakt u een exemplaar van RouteURL. |
Overgenomen eigenschappen
| maps |
Basis-URL-tekenreekswaarde. |
Methoden
| calculate |
Retourneert een route tussen een oorsprong en een bestemming, die door waypoints gaat als deze zijn opgegeven. De route houdt rekening met factoren zoals het huidige verkeer en de typische wegsnelheden op de aangevraagde dag van de week en het tijdstip van de dag. De geretourneerde informatie omvat de afstand, de geschatte reistijd en een weergave van de routegeometrie. Afhankelijk van de geselecteerde opties is ook aanvullende routeringsinformatie beschikbaar, zoals geoptimaliseerde volgorde van waypoints of stapsgewijze instructies. Routeringsservice biedt een set parameters voor een gedetailleerde beschrijving van het voertuigspecifieke verbruiksmodel. Raadpleeg Verbruiksmodel voor een gedetailleerde uitleg van de betrokken concepten en parameters. Als Anders wordt de API Routebeschrijving ophalen gebruikt: https://docs.microsoft.com/rest/api/maps/route/getroutedirections |
| calculate |
Opmerking: deze API is momenteel in preview en kan onderhevig zijn aan belangrijke wijzigingen. Berekent een matrix van routesamenvattingen voor een set routes die zijn gedefinieerd op basis van oorsprong- en doellocaties. Voor elke opgegeven oorsprong berekent deze service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de reeks bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten van routering van de oorsprong naar de bestemming voor die cel. Voor elke route worden de reistijden en afstanden berekend. U kunt de berekende kosten gebruiken om te bepalen welke routes moeten worden berekend met behulp van de Api voor routeringsrichtingen. Als de parameter waitForResults in de aanvraag is ingesteld op false (standaardwaarde), retourneert deze API een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet regelmatig worden gecontroleerd totdat de antwoordgegevens of foutinformatie beschikbaar zijn. De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met die beperking in het achterhoofd zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn). Het berekenen van een routematrix wordt beschouwd als een langdurige bewerking. Een langdurige bewerking impliceert dat nadat de eerste aanvraag is geaccepteerd (HTTP 202), het uiteindelijke resultaat wordt gepeild totdat deze beschikbaar is. Met elke poll-aanvraag wordt de time-out van de aborter opnieuw gestart, als er een is opgegeven. Maakt gebruik van de Post Route Matrix-API: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview |
| calculate |
Een set locaties berekenen die kunnen worden bereikt vanaf het beginpunt op basis van brandstof, energie of tijdsbudget dat is opgegeven. Een veelhoekgrens (of Isochrone) wordt geretourneerd in een richting tegen de klok in, evenals het exacte polygooncentrum dat het resultaat was van het beginpunt. De geretourneerde veelhoek kan worden gebruikt voor verdere verwerking, zoals Search Inside Geometry om te zoeken naar POIs binnen de opgegeven Isochrone. Maakt gebruik van de API Routebereik ophalen: https://docs.microsoft.com/rest/api/maps/route/getrouterange |
Overgenomen methoden
| new |
Een statische methode die wordt gebruikt voor het maken van een nieuw pijplijnobject waarvoor referenties zijn opgegeven. |
Constructordetails
RouteURL(Pipeline, string)
Hiermee maakt u een exemplaar van RouteURL.
new RouteURL(pipeline: Pipeline, mapsUrl?: string)Parameters
- pipeline
- Pipeline
Roep MapsURL.newPipeline() aan om een standaardpijplijn te maken of een aangepaste pijplijn op te geven.
- mapsUrl
-
string
Een URL-tekenreeks die verwijst naar Azure Maps service. De standaardwaarde is "https://atlas.microsoft.com".
Als er geen protocol is opgegeven, bijvoorbeeld "atlas.microsoft.com", https wordt ervan uitgegaan.
Details van overgenomen eigenschap
mapsUrl
Basis-URL-tekenreekswaarde.
mapsUrl: stringWaarde van eigenschap
string
Overgenomen vanMapsURL.mapsUrl
Methodedetails
calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)
Retourneert een route tussen een oorsprong en een bestemming, die door waypoints gaat als deze zijn opgegeven. De route houdt rekening met factoren zoals het huidige verkeer en de typische wegsnelheden op de aangevraagde dag van de week en het tijdstip van de dag. De geretourneerde informatie omvat de afstand, de geschatte reistijd en een weergave van de routegeometrie. Afhankelijk van de geselecteerde opties is ook aanvullende routeringsinformatie beschikbaar, zoals geoptimaliseerde volgorde van waypoints of stapsgewijze instructies.
Routeringsservice biedt een set parameters voor een gedetailleerde beschrijving van het voertuigspecifieke verbruiksmodel. Raadpleeg Verbruiksmodel voor een gedetailleerde uitleg van de betrokken concepten en parameters.
Als options.postBody is opgegeven, wordt de API Post Route Directions gebruikt: https://docs.microsoft.com/rest/api/maps/route/postroutedirections
Anders wordt de API Routebeschrijving ophalen gebruikt: https://docs.microsoft.com/rest/api/maps/route/getroutedirections
function calculateRouteDirections(aborter: Aborter, coordinates: GeoJSON.Position[], options?: CalculateRouteDirectionsOptions): Promise<CalculateRouteDirectionsResponse>Parameters
- aborter
- Aborter
Maak een nieuw Aborter-exemplaar met Aborter.none of Aborter.timeout(), ga naar documenten van Aborter voor meer voorbeelden over annulering van aanvragen.
- coordinates
-
GeoJSON.Position[]
Een matrix van coördinaten waarmee de route wordt berekend.
Elke coördinaat is een matrix van [longitude, latitude]. Er zijn minimaal twee coördinaten vereist.
De eerste is de oorsprong en de laatste is het doel van de route.
Optionele coördinaten tussenin fungeren als WayPoints in de route. U kunt maximaal 150 WayPoints doorgeven.
- options
- CalculateRouteDirectionsOptions
Retouren
Promise<CalculateRouteDirectionsResponse>
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)
Opmerking: deze API is momenteel in preview en kan onderhevig zijn aan belangrijke wijzigingen. Berekent een matrix van routesamenvattingen voor een set routes die zijn gedefinieerd op basis van oorsprong- en doellocaties. Voor elke opgegeven oorsprong berekent deze service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De reeks oorsprongen en de reeks bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel en elke cel in de tabel bevat de kosten van routering van de oorsprong naar de bestemming voor die cel. Voor elke route worden de reistijden en afstanden berekend. U kunt de berekende kosten gebruiken om te bepalen welke routes moeten worden berekend met behulp van de Api voor routeringsrichtingen. Als de parameter waitForResults in de aanvraag is ingesteld op false (standaardwaarde), retourneert deze API een 202-antwoordcode langs een omleidings-URL in het veld Locatie van de antwoordheader. Deze URL moet regelmatig worden gecontroleerd totdat de antwoordgegevens of foutinformatie beschikbaar zijn. De maximale grootte van een matrix voor deze API is 700 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met die beperking in het achterhoofd zijn voorbeelden van mogelijke matrixdimensies: 50x10, 10x10, 28x25. 10x70 (het hoeft niet vierkant te zijn).
Het berekenen van een routematrix wordt beschouwd als een langdurige bewerking. Een langdurige bewerking impliceert dat nadat de eerste aanvraag is geaccepteerd (HTTP 202), het uiteindelijke resultaat wordt gepeild totdat deze beschikbaar is. Met elke poll-aanvraag wordt de time-out van de aborter opnieuw gestart, als er een is opgegeven.
Maakt gebruik van de Post Route Matrix-API: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>Parameters
- aborter
- Aborter
Maak een nieuw Aborter-exemplaar met Aborter.none of Aborter.timeout(), ga naar de documenten van Aborter voor meer voorbeelden over annulering van aanvragen.
De matrix van oorsprong- en doelcoördinaten om de routeafstand, reistijd en andere samenvatting voor elke cel van de matrix te berekenen op basis van de invoerparameters. Het minimale en maximale aantal cellen dat wordt ondersteund, is respectievelijk 1 en 700. Het kan bijvoorbeeld 35 origins en 20 bestemmingen of 25 origins en 25 bestemmingen zijn.
- options
- CalculateRouteMatrixOptions
Retouren
Promise<CalculateRouteMatrixResponse>
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)
Een set locaties berekenen die kunnen worden bereikt vanaf het beginpunt op basis van brandstof, energie of tijdsbudget dat is opgegeven. Een veelhoekgrens (of Isochrone) wordt geretourneerd in een richting tegen de klok in, evenals het exacte polygooncentrum dat het resultaat was van het beginpunt. De geretourneerde veelhoek kan worden gebruikt voor verdere verwerking, zoals Search Inside Geometry om te zoeken naar POIs binnen de opgegeven Isochrone.
Maakt gebruik van de API Routebereik ophalen: https://docs.microsoft.com/rest/api/maps/route/getrouterange
function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>Parameters
- aborter
- Aborter
Maak een nieuw Aborter-exemplaar met Aborter.none of Aborter.timeout(), ga naar de documenten van Aborter voor meer voorbeelden over annulering van aanvragen.
- center
- GeoJSON.Position
De coördinaat van waaruit de bereikberekening moet beginnen.
- options
- CalculateRouteRangeOptions
Retouren
Promise<CalculateRouteRangeResponse>
Details overgenomen methode
newPipeline(Credential, INewPipelineOptions)
Een statische methode die wordt gebruikt voor het maken van een nieuw pijplijnobject waarvoor referenties zijn opgegeven.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParameters
- credential
- Credential
Zoals SubscriptionKeyCredential, TokenCredential en MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Retouren
Een nieuw pijplijnobject.
Overgenomen vanMapsURL.newPipeline