Wyznaczanie trasy

Funkcja traceRoute(routePoints[, params[, callback]])

Funkcja wyznacza trasę o określonych parametrach.

Przyjmowane parametry

routePoints - Tablica ze współrzędnymi kolejnych punktów trasy. Wymagane są co najmniej 2 punkty. Każdy punkt musi mieć podaną długość geograficzną (lon) i szerokość geograficzną (lat).
Kluczem tablicy dla punktu startowego jest DoCelu.START_POINT_DEF. Kluczem tablicy dla punktu końcowego jest DoCelu.STOP_POINT_DEF. Kluczem tablicy dla punktów pośrednich są liczby naturalne 0, 1, 2, ...
params - Dodatkowe parametry trasy. Obiekt zawierający elementy:

routeType - Typ wyznaczonej trasy {DoCelu.ROUTE_TYPE_SHORT, DoCelu.ROUTE_TYPE_FAST}, domyślnie wybrana jest trasa szybka
roadTypes - Tablica z typami dróg, po których wyznaczana jest trasa. Domyślnie wszystkie rodzaje dróg. Dostępne rodzaje:
- DoCelu.ROAD_TYPE_HIGHWAY - autostrady
- DoCelu.ROAD_TYPE_SPEEDWAY - drogi ekspresowe
- DoCelu.ROAD_TYPE_NATIONALROAD - drogi krajowe
- DoCelu.ROAD_TYPE_REGIONALROAD - drogi wojewódzkie
- DoCelu.ROAD_TYPE_LOCALROAD - drogi powiatowe i gminne
- DoCelu.ROAD_TYPE_ALL - wszystkie rodzaje dróg
callBack - funkcja wywoływana po pobraniu wyników. Jeśli nie zostanie zdefiniowana, to wywołana zostanie funkcja callBacks.traceRoute z obiektu konfiguracyjnego API.

Przykład wywołania wyznaczania trasy:


var from = { 
  "lon" : 18.630409240722656, 
  "lat" : 54.334943271492
}; 
var mid = {
  "lon" : 19.97314453125,
  "lat" : 53.76007817077558
};
var to = {
  "lon" : 21.02611541748047,
  "lat" : 52.24472480162969
};
var routePoints = [];
routePoints[DoCelu.START_POINT_DEF] = from;
routePoints[0] = mid;
routePoints[DoCelu.STOP_POINT_DEF] = to;
var params = {
  routeType : DoCelu.ROUTE_TYPE_FAST,
  roadTypes : [DoCelu.ROAD_TYPE_ALL]
};
DoCelu.traceRoute(routePoints, params);

W przypadku wyznaczania trasy będziemy zazwyczaj chcieli wyświetlić wskazówki jazdy. W tym celu należy przechwycić wynik wyznaczania trasy. Zdefiniujemy zatem dwuparametrową funkcję traceRouteCallback o parametrach:

returnStatus - obiekt zawierający status odpowiedzi
response - odpowiedź, wyznaczona trasa ze wskazówkami jazdy

Jeśli funkcja zwróci wartość false, to wynik nie zostanie wyświetlony na mapie, ani zapisany jako ostatni wynik wyszukiwania.
Przykład definicji funkcji:


function traceRouteCallback(ret, response) {
  //developersko przy implementacji funkcjonalności wywołamy sobie
  //jQuery.log(jQuery.dump(response));
  //żeby na dole strony wyświetlić całą dostępną strukturę odpowiedzi
  if (ret.failed) {
    //wystąpił błąd
  } else {
    var $routeEventsDiv = jQuery('#routeEvents');
    var html = 'Trasa z ' + response.startName + '
';
    html += 'Trasa do ' + response.stopName + '
';
    html += 'Odległość ' + response.distance.text + '
';
    html += 'Czas przejazdu ' + response.time.text + '
';
    html += 'Średnia prędkość ' + response.averageSpeed + '
';
    html += 'Wskazówki jazdy:';
    $routeEventsDiv.html(html);
    var $list = jQuery(document.createElement('ul'));
    for (var i in response.events) {
      var text = response.events[i].text + " (" + response.events[i].distance.text + ", " + response.events[i].time.text + ")";
      jQuery(document.createElement('li')).html(text).appendTo($list);
    }
    $list.appendTo($routeEventsDiv);
  }
  //zwracamy null - wynik pojawi się na mapie
  return;
}

Informację, która funkcja ma zostać wywołana należy podać w obiekcie konfiguracyjnym mapy:


var config = {
  "callBacks" : {
    "traceRoute" : traceRouteCallback
  }
};

Obiekt ten można przekazać na etapie ładowania mapy (funkcja loadMap) lub wywołując funkcję loadConfig. W przykładzie zrobimy to na etapie ładowania mapy i od razu uruchomimy obliczanie odległości, aby sprawdzić działanie.


<div id="map" style="width:800px; height:600px; "></div>
<script type="text/javascript">
//<![CDATA[
	jQuery(document).ready(function() {
	  function traceRouteCallback(ret, response) {
		if (ret.failed) {
		  //wystąpił błąd
		} else {
		  var $routeEventsDiv = jQuery('#routeEvents');
		  var html = 'Trasa z ' + response.startName + '
';
		  html += 'Trasa do ' + response.stopName + '
';
		  html += 'Odległość ' + response.distance.text + '
';
		  html += 'Czas przejazdu ' + response.time.text + '
';
		  html += 'Średnia prędkość ' + response.averageSpeed + '
';
		  html += 'Wskazówki jazdy:';
		  $routeEventsDiv.html(html);
		  var $list = jQuery(document.createElement('ul'));
		  for (var i in response.events) {
			var text = response.events[i].text + " (" + response.events[i].distance.text + ", " + response.events[i].time.text + ")";
			jQuery(document.createElement('li')).html(text).appendTo($list);
		  }
		  $list.appendTo($routeEventsDiv);
		}
		//zwracamy null - wynik pojawi się na mapie
		return;
	  }

	  var config = {
		"callBacks" : {
		  "traceRoute" : traceRouteCallback
		}
	  };

	  DoCelu.loadMap(document.getElementById('map'), config);

	  jQuery('#test').mousedown(function() {
		var from = { 
		  "lon" : 18.630409240722656, 
		  "lat" : 54.334943271492
		}; 
		var mid = {
		  "lon" : 19.97314453125,
		  "lat" : 53.76007817077558
		};
		var to = {
		  "lon" : 21.02611541748047,
		  "lat" : 52.24472480162969
		};
		var routePoints = [];
		routePoints[DoCelu.START_POINT_DEF] = from;
		routePoints[0] = mid;
		routePoints[DoCelu.STOP_POINT_DEF] = to;
		var params = {
		  routeType : DoCelu.ROUTE_TYPE_FAST,
		  roadTypes : [DoCelu.ROAD_TYPE_ALL]
		};
		DoCelu.traceRoute(routePoints, params);
	  });
	});
//]]>
</script>