JsDoc: Joms.Route

Joms.Route(app, id, cfg, searchCfg)

Slouží k hledání tras v mapě, výpisu jejího itineráře, získání výškového profilu a informací o trase. Objekt musí být vytvořen až po zavolání metody Joms.App.init

příklad použití

Viz ukázky.

parametry

Joms.App	app	Objekt aplikace
String	id	Textový identifikátor trasy
Joms.RouteConf	cfg?	Konfigurační objekt.
Joms.SearchConf	searchCfg?	Konfigurační objekt vyhledávání.

metody

addDestination(coordOrQuery, destId)

removeDestination(destination)

removeLastDestination()

getDestinations()

setCriterium(criterium, criteriumParam)

banRoutesInArea(point, radius)

unbanAllRoutes()

show()

hide()

showDestinations()

setDestinationsIcon(icon)

hideDestinations()

destroy()

destroyRoute()

search()

isValid()

getLength()

getTime()

getItinerary(eln, detailed, crossroads, destinations, stats, commands)

zoomToRoute()

updateDrawParams()

getHeightProfile(element, width, height)

getHeightProfileImageUrl(width, height, oneLine)

vlastnosti

double length Délka vyhledané trasy v kilometrech (s přesností na metry).

int time Čas potřebný k absolvování vyhledané trasy v sekundách.

int ascent Celkové překonané stoupání na vyhledané trase v metrech.

int descent Celkové klesání na vyhledané trase v metrech.

Joms.Rect envelopeRect Minimální souřadnicová obálka vyhledané trasy.

Joms.Route.addDestination(coordOrQuery, destId)

Přidá destinaci do destinací (průjezdních bodů) této trasy (na konec seznamu). Pokud je vlastnost autoUpdate objektu trasy true, pak je trasa automaticky přepočtena.

parametry

Mixed	coordOrQuery	Destinace. Může být zadána buď ve formě Joms.Coord či textu, který bude vyhledán geocodingem.
String	destId	Id destinace (nepovinné)

vrací

Joms.Destination

objekt vytvořené destinace.

Joms.Route.removeDestination(destination)

Odstraní zadanou destinaci z trasy

parametry

destination

vrací

boolean

true pokud byla destinace úspěšně odstraněna

Joms.Route.removeLastDestination()

Odstraní poslední destinaci z trasy

Joms.Route.getDestinations()

Vráti array s destinacemi trasy v pořadí, v pořadí průběhu trasy.

Joms.Route.setCriterium(criterium, criteriumParam)

Nastaví kritérium a parametr, podle kterého je trasa vyhledávána. Pokud je vlastnost autoUpdate objektu trasy true, pak je trasa automaticky přepočtena.

parametry

Joms.Route.Criterium	criterium	Kritérium, podle kterého bude trasa vyhledána.
boolean	criteriumParam	Dodatečný parametr kritéria.

Joms.Route.banRoutesInArea(point, radius)

Zakáže použití všech úseků cest ve čtvercovém okolí bodu point o poloměru radius. Tyto úseky pak nebudou použity při plánování tras.

parametry

	point
	radius

Joms.Route.unbanAllRoutes()

Povolí všechny předtím zakázané úseky cest

Joms.Route.show()

Zobrazí trasu v mapě (po jejím schování metodou hide).

Joms.Route.hide()

Schová trasu.

Joms.Route.showDestinations()

Schová destinace trasy (standardně vlaječky)

Joms.Route.setDestinationsIcon(icon)

Nastaví ikonu, kterou jsou znázorněny destinace v mapě

parametry

Joms.Icon

icon

ikona destinací

Joms.Route.hideDestinations()

Zobrazí destinace trasy (standardně vlaječky)

Joms.Route.destroy()

Odstraní trasu z mapy, vymaže všechny destinace a výsledky.

Joms.Route.destroyRoute()

Odstraní vyhledanou trasu, ponechá destinace

Joms.Route.search()

Vyhledá trasu. Po úspěšném zpracování odpovědi je volán hook 'routeSearched'. Před vyhledáním je nutné přidat alespoň dvě destinace. Pokud jsou destinace zadány textem, pak před vyhledáním trasy je spuštěno vyhledávání v databázích (geocoding) a destinacím je přiřazena souřadnice.

Joms.Route.isValid()

Vrátí true, pokud trasa byla úspěšně vyhledána a je plně k dispozici (k znázornění v mapě, získání itineráře atd.), jinak false.

Joms.Route.getLength()

Vrátí délku trasy

Joms.Route.getTime()

Vrátí čas potřebný k absolvování trasy ve formátu HH:mm:ss.

Joms.Route.getItinerary(eln, detailed, crossroads, destinations, stats, commands)

Do zadaného DOM elementu vloží HTML itinerář popisující vyhledanou trasu.

parametry

Mixed	eln	Elementu, do kterého bude itinerář vložen jako hodnota innerHTML. Může být zadán buď ID elementu či přímo objekt.
Boolean	detailed?	Detailní nebo krátký výpis. Výchozí hodnota false.
Boolean	crossroads?	Má výpis obsahovat popis křižovatek? Výchozí hodnota true.
Boolean	destinations?	Má výpis obsahovat seznam destinací? Výchozí hodnota false.
Boolean	stats?	Má výpis obsahovat statistiky trasy? Výchozí hodnota false.
Boolean	commands?	Má výpis obsahovat příkazy? Výchozí hodnota false.

Joms.Route.zoomToRoute()

Posune a přiblíží/oddálí mapu tak, aby byla trasa celá viditelná a vystředěná na střed.

Joms.Route.updateDrawParams()

Aktualizuje změny v nastavení grafických parametrů trasy a trasu v mapě překreslí.

Joms.Route.getHeightProfile(element, width, height)

Do elementu s daným ID vloží obrázek výškového profilu vyhledané trasy. Vytvoří interaktivní značky križovatek ve výškovém profilu

parametry

Element	element	element, do kterého je profil vložen.
int	width	šířka vytvořeného profilu
int	height	výška vytvořeného profilu

Joms.Route.getHeightProfileImageUrl(width, height, oneLine)

Vrací URL statického obrázku s výškovým profilem. Toto URL je pak možné vložit do src image elementu a získat tak obrázek pro tisk.

parametry

int	width	šířka obrázku v pixelech
int	height	výška obrázku v pixelech
boolean	oneLine	příznak zda má být výškový profil jednořádkový. Pokud je false, pak budou dlouhe profily rozloženy do více řádků a parametr height udává výšku jednoho řádku, nikoliv celého obrázku.