Třída SMap.Route
Požadavek na vyhledání trasy
Rozšiřuje
JAK.ISignals
Posílá tyto signály:
- route-request
- route-response
Atributy konstruktoru | Název a popis kontruktoru |
---|---|
SMap.Route(coords, callback, params)
|
Atributy vlastnosti | Název a popis vlastnosti |
---|---|
<statická> |
Atributy metody | Jméno a popis metody |
---|---|
<statická> | |
send()
Ručně volat jen pokud bylo do konstruktoru posláno autoSend:false
|
|
abort()
Přerušit běžící požadavek
|
|
Vrátí pole průjezdních bodů
|
|
Vrátí criterion, tedy parametry route
|
|
Vrátí výsledek plánování. Je to objekt s těmito hlavními vlastnostmi:
|
|
<statická> |
route(coords, paramsArgs)
Konfigurace routovace - zavola dotaz podle zadanych parametru, vraci promise.
Defaultne ma vypnute obohaceni dat o nadmorske vysky.
|
Konstruktor - detail
SMap.Route(coords, callback, params)
- Parametry:
- {Array[SMap.Coords]} coords
- Pole bodů, skrz které vede trasa
- {function} callback
- Funkce zavolaná po nalezení trasy
- {object} params volitelný
- Volitelná konfigurace
- {string} params.criterion volitelný
- Druh trasy: "fast", "short", "bike1", "bike2", "bike3", "turist1", "turist2"
- {string} params.autoSend volitelný, výchozí: true
- Automaticky poslat dotaz pri vytvoreni
- {string} params.toll volitelný
- "free" = bez poplatků (jen pro criterion=fast/short)
- {boolean} params.altitude volitelný, výchozí: true
- obohatit data o nadmorske vysky?
- {boolean} params.geometry volitelný, výchozí: true
- vracet geometrie trasy?
- {boolean} params.itinerary volitelný, výchozí: true
- vracet itinerar trasy?
- {int} params.avoidtraffic volitelný, výchozí: 1
- ignorovat velké silnice (jen pro criterion=bikeN)
Vlastnosti - detailně
<statická>
SMap.Route.ROUTE_TURIST_TYPES
Metody - detailně
<statická>
SMap.Route.formatRouteDistance()
$destructor()
send()
Ručně volat jen pokud bylo do konstruktoru posláno autoSend:false
abort()
Přerušit běžící požadavek
{Array[SMap.Coords]}
getCoords()
Vrátí pole průjezdních bodů
- Vrací:
- {Array[SMap.Coords]}
{string}
getCriterion()
Vrátí criterion, tedy parametry route
- Vrací:
- {string}
getResults()
Vrátí výsledek plánování. Je to objekt s těmito hlavními vlastnostmi:
- geometry – pole souřadnic geometrie trasy
- altitude – pole nadmořských výšek pro jednotlivé body geometrie
- points – pole průjezdních bodů; každý bod je další (zatím nedokumentovaný) složitý objekt
- ascent – celkové stoupání
- descent – celkové klesání
- url – routovací adresa
- inEurope – vede-li trasa též mimo ČR
- length – celková délka trasy v metrech
- time – celkový čas trasy ve vteřinách
getPromise()
<statická>
{JAK.Promise}
SMap.Route.route(coords, paramsArgs)
Konfigurace routovace - zavola dotaz podle zadanych parametru, vraci promise.
Defaultne ma vypnute obohaceni dat o nadmorske vysky.
- Parametry:
- {Array[SMap.Coords]} coords
- Pole bodů, skrz které vede trasa
- {Object} paramsArgs
- Konfigurace vystupnich dat
- {string} paramsArgs.criterion volitelný
- Druh trasy: "fast", "short", "bike1", "bike2", "bike3", "turist1", "turist2"
- {Boolean} paramsArgs.geometry volitelný, výchozí: false
- S geometrii? Pokud nechci basic informace
- {Boolean} paramsArgs.itinerary volitelný, výchozí: false
- S itinerarem? Pokud nechci basic informace
- {boolean} paramsArgs.altitude volitelný, výchozí: false
- obohatit data o nadmorske vysky?
- Vrací:
- {JAK.Promise} vraci instanci dat pro trasu, pres getResults si muzete nacist vysledky