RouteURL class
RouteURL představuje adresu URL Azure Maps operací směrování.
- Extends
Konstruktory
RouteURL(Pipeline, string) | Vytvoří instanci RouteURL. |
Zděděné vlastnosti
maps |
Hodnota základního řetězce adresy URL. |
Metody
calculate |
Vrátí trasu mezi počátečním a cílovým místem, která prochází směrovými body, pokud jsou zadané. Trasa bude brát v úvahu faktory, jako je aktuální provoz a typická rychlost silnic v požadovaný den v týdnu a denní čas. Vrácené informace zahrnují vzdálenost, odhadovanou dobu jízdy a reprezentaci geometrie trasy. V závislosti na vybraných možnostech jsou k dispozici i další informace o směrování, jako je optimalizované pořadí tras nebo pokyny pro otáčení. Směrovací služba poskytuje sadu parametrů pro podrobný popis modelu spotřeby specifického pro vozidlo. Podrobné vysvětlení příslušných konceptů a parametrů najdete v modelu Consumption . Pokud V opačném případě použije rozhraní API Get Route Directions: https://docs.microsoft.com/rest/api/maps/route/getroutedirections |
calculate |
Poznámka: Toto rozhraní API je aktuálně ve verzi Preview a může se na ně vztahovat zásadní změny. Vypočítá matici souhrnů tras pro sadu tras definovaných výchozím a cílovým umístěním. Pro každý daný zdroj tato služba vypočítá náklady na směrování z tohoto zdroje do každého daného cíle. Množinu počátků a cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování od zdroje do cíle pro danou buňku. Pro každou trasu se počítají doby jízdy a vzdálenosti. Vypočítané náklady můžete použít k určení tras, které se mají vypočítat, pomocí rozhraní API Směr směrování. Pokud je parametr waitForResults v požadavku nastavený na hodnotu false (výchozí hodnota), vrátí toto rozhraní API kód odpovědi 202 spolu s adresou URL přesměrování v poli Umístění hlavičky odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Maximální velikost matice pro toto rozhraní API je 700 (počet původů vynásobený počtem cílů). S ohledem na toto omezení jsou příklady možných dimenzí matice: 50x10, 10x10, 28x25. 10x70 (nemusí být čtvercové). Výpočet matice tras se považuje za dlouhotrvající operaci. Dlouhotrvající operace znamená, že po přijetí počátečního požadavku (HTTP 202) se bude dotazovat na konečný výsledek, dokud nebude dostupný. Každá žádost o hlasování restartuje časový limit aborteru, pokud byl zadán. Používá rozhraní API Post Route Matrix: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview |
calculate |
Vypočítejte sadu míst, ke kterým lze dosáhnout z bodu původu, na základě zadaného paliva, energie nebo časového rozpočtu. Hranice mnohoúhelníku (neboli Isochrone) je vrácena v proti směru hodinových ručiček a také přesným středem mnohoúhelníku, který byl výsledkem počátečního bodu. Vrácený mnohoúhelník lze použít k dalšímu zpracování, jako je například Search Vnitřní geometrie k vyhledání BZ v rámci zadaného isochronu. Používá rozhraní API Pro získání rozsahu tras: https://docs.microsoft.com/rest/api/maps/route/getrouterange |
Zděděné metody
new |
Statická metoda použitá k vytvoření nového objektu kanálu se zadanými přihlašovacími údaji. |
Podrobnosti konstruktoru
RouteURL(Pipeline, string)
Vytvoří instanci RouteURL.
new RouteURL(pipeline: Pipeline, mapsUrl?: string)
Parametry
- pipeline
- Pipeline
Zavolejte MapsURL.newPipeline() a vytvořte výchozí kanál nebo poskytněte vlastní kanál.
- mapsUrl
-
string
Řetězec adresy URL odkazující na službu Azure Maps, výchozí hodnota je "https://atlas.microsoft.com"
.
Pokud není zadán žádný protokol, například "atlas.microsoft.com"
, https
pak se předpokládá.
Podrobnosti zděděných vlastností
mapsUrl
Hodnota základního řetězce adresy URL.
mapsUrl: string
Hodnota vlastnosti
string
Zděděno zMapsURL.mapsUrl
Podrobnosti metody
calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)
Vrátí trasu mezi počátečním a cílovým místem, která prochází směrovými body, pokud jsou zadané. Trasa bude brát v úvahu faktory, jako je aktuální provoz a typická rychlost silnic v požadovaný den v týdnu a denní čas. Vrácené informace zahrnují vzdálenost, odhadovanou dobu jízdy a reprezentaci geometrie trasy. V závislosti na vybraných možnostech jsou k dispozici i další informace o směrování, jako je optimalizované pořadí tras nebo pokyny pro otáčení.
Směrovací služba poskytuje sadu parametrů pro podrobný popis modelu spotřeby specifického pro vozidlo. Podrobné vysvětlení příslušných konceptů a parametrů najdete v modelu Consumption .
Pokud options.postBody
je zadaný, použije rozhraní API Post Route Directions: https://docs.microsoft.com/rest/api/maps/route/postroutedirections
V opačném případě použije rozhraní 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
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
- coordinates
-
GeoJSON.Position[]
Pole souřadnic, přes které se trasa počítá.
Každá souřadnice je polem [longitude, latitude]
. Vyžadují se minimálně dvě souřadnice.
První z nich je původ a poslední je cíl trasy.
Volitelné souřadnice in-between fungují jako waypointy v trase. Můžete předat až 150 waypointů.
- options
- CalculateRouteDirectionsOptions
Návraty
Promise<CalculateRouteDirectionsResponse>
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)
Poznámka: Toto rozhraní API je aktuálně ve verzi Preview a může se na ně vztahovat zásadní změny. Vypočítá matici souhrnů tras pro sadu tras definovaných výchozím a cílovým umístěním. Pro každý daný zdroj tato služba vypočítá náklady na směrování z tohoto zdroje do každého daného cíle. Množinu počátků a cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování od zdroje do cíle pro danou buňku. Pro každou trasu se počítají doby jízdy a vzdálenosti. Vypočítané náklady můžete použít k určení tras, které se mají vypočítat, pomocí rozhraní API Směr směrování. Pokud je parametr waitForResults v požadavku nastavený na hodnotu false (výchozí hodnota), vrátí toto rozhraní API kód odpovědi 202 spolu s adresou URL přesměrování v poli Umístění hlavičky odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Maximální velikost matice pro toto rozhraní API je 700 (počet původů vynásobený počtem cílů). S ohledem na toto omezení jsou příklady možných dimenzí matice: 50x10, 10x10, 28x25. 10x70 (nemusí být čtvercové).
Výpočet matice tras se považuje za dlouhotrvající operaci. Dlouhotrvající operace znamená, že po přijetí počátečního požadavku (HTTP 202) se bude dotazovat na konečný výsledek, dokud nebude dostupný. Každá žádost o hlasování restartuje časový limit aborteru, pokud byl zadán.
Používá rozhraní API Post Route Matrix: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>
Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
Matice souřadnic původu a cíle pro výpočet vzdálenosti trasy, doby jízdy a dalšího souhrnu pro každou buňku matice na základě vstupních parametrů. Minimální a maximální podporovaný počet buněk jsou 1 a 700 v uvedeném pořadí. Může to být například 35 počátek a 20 cílů nebo 25 počátek a 25 cílů.
- options
- CalculateRouteMatrixOptions
Návraty
Promise<CalculateRouteMatrixResponse>
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)
Vypočítejte sadu míst, ke kterým lze dosáhnout z bodu původu, na základě zadaného paliva, energie nebo časového rozpočtu. Hranice mnohoúhelníku (neboli Isochrone) je vrácena v proti směru hodinových ručiček a také přesným středem mnohoúhelníku, který byl výsledkem počátečního bodu. Vrácený mnohoúhelník lze použít k dalšímu zpracování, jako je například Search Vnitřní geometrie k vyhledání BZ v rámci zadaného isochronu.
Používá rozhraní API Pro získání rozsahu tras: https://docs.microsoft.com/rest/api/maps/route/getrouterange
function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>
Parametry
- aborter
- Aborter
Vytvořte novou instanci Aborter pomocí Aborter.none nebo Aborter.timeout(), získat dokumenty Aborter, kde najdete další příklady zrušení žádosti.
- center
- GeoJSON.Position
Souřadnice, ze které by měl výpočet rozsahu začínat.
- options
- CalculateRouteRangeOptions
Návraty
Promise<CalculateRouteRangeResponse>
Podrobnosti zděděných metod
newPipeline(Credential, INewPipelineOptions)
Statická metoda použitá k vytvoření nového objektu kanálu se zadanými přihlašovacími údaji.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline
Parametry
- credential
- Credential
Například SubscriptionKeyCredential, TokenCredential a MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Návraty
Nový objekt kanálu.
Zděděno zMapsURL.newPipeline