Klasa odpowiedzialna za wyznaczanie tras i wizualizowanie ich na mapie.
EMAPI. | Klasa odpowiedzialna za wyznaczanie tras i wizualizowanie ich na mapie. |
Functions | |
EMAPI. | Konstruktor nowej instancji klasy EMAPI.Router. |
addWaypoint | Dodaje nowy punkt trasy do listy wayPoints. |
setWaypoint | Zmienia położenie punktu trasy. |
removeWaypoints | Usuwa wszystkie punkt trasy z listy wayPoints. |
removeWaypoint | Usuwa wybrany punkt trasy z listy wayPoints. |
swapWaypoint | Zamienia kolejnością wybrane dwa punky trasy z listy wayPoints. |
calculateRoute | Oblicza trasę pomiędzy punktami umieszczonymi w liście wayPoints po podaniu wybranego pojazdu, kierowcy i parametrów wyznaczania trasy. |
activateRoute | Aktywuję wybraną trasę spośród wyznaczonych tras alternatywnych. |
drivers | Zwraca listę kierowców używanych podczas wyznaczania trasy. |
vehicles | Zwraca listę pojazdów używanych podczas wyznaczania trasy. |
wayPoints | Zwraca listę punktów trasy. |
routeRepresentation | Zwraca wyniki wyznaczonej trasy. |
Konstruktor nowej instancji klasy EMAPI.Router.
obj | {Object} Obiekt klasy EMAPI.Map lub tekstowy token klienta. |
options | {Object} Obiekt z dodatkowymi parametrami instancji klasy, np. preserveViewport (wyłączenie zmiany położenia mapy), forceCalc (automatyczne wyznaczanie trasy po zmianach), reportPointsHandlerPointsName (identyfikator elementu na stronie, który ma zawierać listę punktów trasy), reportResultHandlerName (identyfikator elementu na stronie, który ma zawierać raport trasy), routeLineColor (kolor linii trasy), alternativeRouteLineColor (kolor linii trasy alternatywnej), tollRouteLineColor (kolor trasy płatnej), routeLineWidth (grubość linii trasy). |
addWaypoint: function( lonLat, pointType, callback )
Dodaje nowy punkt trasy do listy wayPoints. Dane przekazywane do podstawianej w trzecim parametrze funkcji zawierają:
lonLat | {EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne geograficzne punktu trasy. |
pointType | {Integer} Typ punktu trasy: 0 = punkt startowy, 1 = punkt przelotowy, 2 = punkt końcowy. Punkt przelotowy dodawany jest zawsze tuż przed końcowym. |
callback | {Function} Funkcja obsługi danych geograficznych wskazanego punktu. |
setWaypoint: function( index, lonLat, callback )
Zmienia położenie punktu trasy. Dane przekazywane do podstawianej w trzecim parametrze funkcji zawierają:
index | {Integer} Indeks punktu trasy w ramach listy wayPoints: 0 = punkt startowy, itd. |
lonLat | {EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne geograficzne punktu trasy. |
callback | {Function} Funkcja obsługi danych geograficznych wskazanego punktu. |
removeWaypoints: function()
Usuwa wszystkie punkt trasy z listy wayPoints.
swapWaypoint: function( firstPointIndex, secondPointIndex )
Zamienia kolejnością wybrane dwa punky trasy z listy wayPoints.
firstPointIndex | {Integer} Indeks pierwszego zamienianego punktu trasy w ramach listy wayPoints. |
secondPointIndex | {Integer} Indeks drugiego zamienianego punktu trasy w ramach listy wayPoints. |
calculateRoute: function ( vehicle, driver, roadType, routeOptions, callback, force, params )
Oblicza trasę pomiędzy punktami umieszczonymi w liście wayPoints po podaniu wybranego pojazdu, kierowcy i parametrów wyznaczania trasy. Dane przekazywane do podstawianej w parametrze callback funkcji zawierają:
vehicle | {EMAPI.Router.VehicleParams} Obiekt typu EMAPI.Router.VehicleParams reprezentujący ustawienia związane z pojazdem, który ma być użyty do wyznaczenia trasy. |
driver | {EMAPI.Router.DriverParams} Obiekt typu EMAPI.Router.DriverParams reprezentujący ustawienia związane z pojazdem, który ma być użyty do wyznaczenia trasy. |
roadType | {Integer} Typ obliczania trasy: 0 = najkrótsza, 1 = najszybsza, 2 = najtańsza. |
routeOptions | {Object} Obiekt zawierający opcje wyznaczania trasy w postaci pól logicznych: useDifficulties = true wymusza wykorzystanie utrudnień w ruchu, useFerry = true włącza wykorzystanie promów, useGroundRoad = true włącza wykorzystanie dróg gruntowych, useTrafficTI = true włącza wykorzystanie aktualnej informacji Traffic, useArchivalTraffic = true włącza wykorzystanie informacji o archiwalnymTraffic, useLogistic = true włącza wykorzystanie restrykcji drogowych, avoidToll = true włącza omijanie dróg płatnych, viaToll = true włącza wykorzystanie naliczania kosztów viaTOLL, avoidViaToll = true włącza omijanie dróg objętych systemem viaTOLL, useVignette = true włącza wykorzystanie naliczania kosztów dróg z winietami, useSoftRestrictions = true umożliwia dojazd do zablokowanego punktu trasy, avoidLowCategoryRoads = true włącza omijanie dróg niskiej kategorii, alternativeRoutes = true włącza wyznaczanie do dwóch dodatkowych tras alternatywnych (opcja nieaktywna gdy włączono opcję useToll), useToll = true włącza wykorzystanie i zwracanie podsumowania dróg płatnych w całej Europie, noTaxCosts = true zmienia kwoty wynikowe opłat drogowych na netto (domyślnie zwracane są kwoty brutto), includeViaTollCosts = true włącza koszty viaTOLL do kosztów sumarycznych i szczegółowych zwracanych w raporcie trasy, includeTollCosts = true włącza opłaty drogowe w Europie do kosztów sumarycznych i szczegółowych zwracanych w raporcie trasy. |
callback | {Function} Funkcja obsługi rezultatów wyznaczonej trasy. |
force | {Boolean} Informacja czy obliczyć trasę natychmiast, czy też oczekiwać na zakończenie wyznaczania wcześniejszych tras. |
params | {Object} Dodatkowe parametry wyznaczania trasy: currency (waluta parametrów i wyników w postaci 3-literowego międzynarodowego kodu waluty, domyślnie PLN), vinettespanday (czas obowiązywania winiety w postaci zakresu dni, domyślnie 7-14), returnMapaMapRoute (wartość true powoduje zwrócenie dodatkowego pliku trasy wynikowej w formacie nawigacyjnym MapaMap). |
drivers: function()
Zwraca listę kierowców używanych podczas wyznaczania trasy.
{EMAPI.ArrayObjects} Lista kierowców używanych podczas wyznaczania trasy. Jest to tablica obiektów klasy EMAPI.Router.DriverParams zarządzana poprzez obiekt klasy EMAPI.ArrayObjects. Domyślnie zawiera one parametry następujących kierowców reprezentujących typowe zastosowania: Experienced i Unexperienced.
vehicles: function()
Zwraca listę pojazdów używanych podczas wyznaczania trasy.
{EMAPI.ArrayObjects} Lista pojazdów używanych podczas wyznaczania trasy. Jest to tablica obiektów klasy EMAPI.Router.VehicleParams zarządzana poprzez obiekt klasy EMAPI.ArrayObjects. Domyślnie zawiera one parametry następujących pojazdów reprezentujących typowe zastosowania: Passenger car, Fast passenger car, Transport truck 10t, Transport truck 20t, Delivery truck, Motorcycle, Bicycle i Pedestrian.
wayPoints: function()
Zwraca listę punktów trasy.
{EMAPI.ArrayObjects} Lista punktów trasy. Jest to tablica obiektów klasy EMAPI.Router.WayPoint zarządzana poprzez obiekt klasy EMAPI.ArrayObjects lub funkcjami addWaypoint, setWaypoint, removeWaypoint, removeWaypoints i swapWaypoint. Domyślnie jest pusta.
routeRepresentation: function()
Zwraca wyniki wyznaczonej trasy.
{EMAPI.Router.RouteRepresentation} Reprezentacja i parametry wyznaczonej za pomocą funkcji calculateRoute trasy.
Dodaje nowy punkt trasy do listy wayPoints.
addWaypoint: function( lonLat, pointType, callback )
Zwraca listę punktów trasy.
wayPoints: function()
Zmienia położenie punktu trasy.
setWaypoint: function( index, lonLat, callback )
Usuwa wszystkie punkt trasy z listy wayPoints.
removeWaypoints: function()
Usuwa wybrany punkt trasy z listy wayPoints.
removeWaypoint: function( index )
Zamienia kolejnością wybrane dwa punky trasy z listy wayPoints.
swapWaypoint: function( firstPointIndex, secondPointIndex )
Oblicza trasę pomiędzy punktami umieszczonymi w liście wayPoints po podaniu wybranego pojazdu, kierowcy i parametrów wyznaczania trasy.
calculateRoute: function ( vehicle, driver, roadType, routeOptions, callback, force, params )
Aktywuję wybraną trasę spośród wyznaczonych tras alternatywnych.
activateRoute: function( index )
Zwraca listę kierowców używanych podczas wyznaczania trasy.
drivers: function()
Zwraca listę pojazdów używanych podczas wyznaczania trasy.
vehicles: function()
Zwraca wyniki wyznaczonej trasy.
routeRepresentation: function()