EMAPI.Router

Klasa odpowiedzialna za wyznaczanie tras i wizualizowanie ich na mapie.

Podsumowanie

EMAPI.Router	Klasa odpowiedzialna za wyznaczanie tras i wizualizowanie ich na mapie.
Functions
EMAPI.Router	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.

Functions

EMAPI.Router

Konstruktor nowej instancji klasy EMAPI.Router.

Parametry

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

addWaypoint: function( lonLat,
pointType,
callback )

Dodaje nowy punkt trasy do listy wayPoints. Dane przekazywane do podstawianej w trzecim parametrze funkcji zawierają:

zdegeokodowaną informację o geograficznym położeniu punktu (routePlanEntryDescription)
kod błędu (result: 0 = ok, 1 = niepoprawny typ punktu, 2 = zabronione położenie punktu)

Parametry

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

setWaypoint: function( index,
lonLat,
callback )

Zmienia położenie punktu trasy. Dane przekazywane do podstawianej w trzecim parametrze funkcji zawierają:

zdegeokodowaną informację o nowym geograficznym położeniu punktu (routePlanEntryDescription)
kod błędu (result: 0 = ok, 1 = niepoprawny indeks punktu, 2 = zabronione położenie punktu)

Parametry

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

removeWaypoints: function()

Usuwa wszystkie punkt trasy z listy wayPoints.

removeWaypoint

removeWaypoint: function( index )

Usuwa wybrany punkt trasy z listy wayPoints.

Parametry

index

{Integer} Indeks punktu trasy w ramach listy wayPoints.

swapWaypoint

swapWaypoint: function( firstPointIndex,
secondPointIndex )

Zamienia kolejnością wybrane dwa punky trasy z listy wayPoints.

Parametry

firstPointIndex	{Integer} Indeks pierwszego zamienianego punktu trasy w ramach listy wayPoints.
secondPointIndex	{Integer} Indeks drugiego zamienianego punktu trasy w ramach listy wayPoints.

calculateRoute

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ą:

wyniki i raport trasy (routeRepresentation będący obiektem klasy EMAPI.Router.RouteRepresentation)
statystykę użycia różnych typów dróg (roadResults będący tablicą zawierającą dane statystyczne dla każdego typu drogi, tzn. długość, czas i koszty trasy na drogach tego typu, dostępne typy dróg odpowiadają wartościom pola EMAPI.Router.RoadParams.roadType)
zestawienie sumaryczne opłat drogowych różnego typu z podziałem na kraje (logisticTollResults) zawierające: kraj (Country), typ opłaty (Type), oryginalną walutę (Currency), kwotę opłaty w oryginalnej walucie (OriginalCurrency), kwotę opłaty w walucie zadanej (LocalCurrency), stawkę podatku (Tax)
kod błędu (result: 0 = ok, 1 = trasa nie została wyznaczona)

Parametry

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).

activateRoute

activateRoute: function( index )

Aktywuję wybraną trasę spośród wyznaczonych tras alternatywnych.

Parametry

index

{Integer} Indeks trasy (począwszy od 0 dla pierwszej, która jest aktywna zaraz po wyznaczeniu tras).

drivers

drivers: function()

Zwraca listę kierowców używanych podczas wyznaczania trasy.

Wynik

{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

vehicles: function()

Zwraca listę pojazdów używanych podczas wyznaczania trasy.

Wynik

{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

wayPoints: function()

Zwraca listę punktów trasy.

Wynik

{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

routeRepresentation: function()

Zwraca wyniki wyznaczonej trasy.

Wynik

{EMAPI.Router.RouteRepresentation} Reprezentacja i parametry wyznaczonej za pomocą funkcji calculateRoute trasy.