Okręgi

Funkcja służy do dodawania okręgów na mapie.

Przyjmowane parametry

1. circles - Tablica obiektów okręgów.
   
2. callBack - funkcja wywoływana po pobraniu wyników. Jeśli nie zostanie zdefiniowana, to wywołana zostanie funkcja callBacks.addCircles z obiektu konfiguracyjnego API.

Tryby dodawania obiektów

1. Single - przeznaczony do dodawania/usuwania małej ilości obiektów. Charakteryzuje się tym, że we flashu obiekty nie są spłaszczane. Dzięki temu nie ma potrzeby rysowania od nowa wszystkich obiektów po dodaniu lub usunięciu jednego z nich. Jednak przez brak spłaszczenia nie jest to rozwiązanie wydajne przy dużej ilości obiektów.
   
2. Bulk - przeznaczony do dodawania/usuwania dużej ilości obiektów. Charakteryzuje się tym, że we flashu obiekty są spłaszczane, co powoduje zwiększenie wydajności przy dużej liczbie obiektów. Dodanie lub usunięcie pojedynczego obiektu skutkuje jednak tym, że wszystkie widoczne obiekty muszą być przerysowane od nowa.

Niezbędne atrybuty

1. Dwa punkty - uzupełniamy zmienną "points" punktem środka okręgu (pierwszy wymiar)) i punktem przecięcia promienia z okręgiem (drugi wymiar). Każdy punkt musi mieć podaną długość geograficzną (lon) i szerokość geograficzną (lat).
   
2. Punkt (środek) i promień - uzupełniamy zmienną "point" punktem środka okręgu a "radius" uzupełniamy długością promienia w kilometrach. Punkt (środek) musi mieć podaną długość geograficzną (lon) i szerokość geograficzną (lat).

Przykład wywołania dodania okręgu:

//okrąg stworzony z punku środka i promienia
var point = {
	"lon" : 18.630409240722656,
	"lat" : 54.334943271492
};
var circle = {
	"id" : 1, // unikalne id
	"categoryId" : 1, // id warstwy na której leżeć ma obiekt
	"point" : point, // punkty składowe
	"radius" : 100, // promień
	"point" : point, // środek
	"lineColor" : "0x000000", // kolor lini
	"lineOpacity" : 1, // przeźroczystość lini
	"lineSize" : 1, // grubość lini (w pikselach)
	"fillColor" : "0x00ff00", // kolor wypełnienia
	"fillOpacity" : 0.7, // przeźroczystość wypełnienia
	"layer" : "<div style=\"width:226px;height:76px;background: #ffffff
				url('http://docelu.pl/i/docelu.gif')
				no-repeat\" />", // layerek
	"mode" : "bulk", // tryb dodawania obiektów
	"zoomFrom" : 1, // minimalne powiększenie, od którego widać obiekt
	"zoomTo" : 15, // maksymalne powiększenie, do którego widać obiekt
	"externalOver" : "mouseOver", // funkcja uruchamiana na zdarzenie onmouseover
	"externalOut" : "mouseOut" // funkcja uruchamiana na zdarzenie onmouseout
};
DoCelu.addCircles([circle]);

//okrąg stworzony z dwóch punktów
var point1 = { //Warszawa
	"lon" : 21.005859,
	"lat" : 52.254709
};

var point2 = { //Kraków
	"lon" : 19.929199,
	"lat" : 50.092393
};

var points = [];
points[0] = point1;
points[1] = point2;

var circle2 = {
	"id" : 2,
	"categoryId" : 1,
	"points" : points, // dwa punkty (środek i punkt przecięcia promienia z okręgiem)
	"lineColor" : "0x000000",
	"lineOpacity" : 1,
	"lineSize" : 1,
	"fillColor" : "0x0000ff",
	"fillOpacity" : 0.7,
	"externalOver" : "mouseOver",
	"externalOut" : "mouseOut",
	"mode" : "bulk",
	"zoomFrom" : 1,
	"zoomTo" : 15
};
DoCelu.addCircles([circle2]);

Można przechwycić wynik operacji rysowania okręgu. Zdefiniujemy zatem jednoparametrową funkcję addCirclesCallback z parametrem:

1. returnStatus - obiekt zawierający status odpowiedzi

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

function addCirclesCallback(ret) {
	var $circlesEventsDiv = jQuery('#circlesEvents');
	var html = '<h3>Okrąg dodany.</h3>';
	$circlesEventsDiv.html(html);
	return;
}

Informację, która funkcja ma zostać wywołana należy podać w obiekcie konfiguracyjnym mapy. W obiekcie tym definiujemy również opóźnienie w wyświetleniu chmurki dla kształtu:

var config = {
  "features" : {
    "detailsShowDelay" : 500
  },
  "callBacks" : {
    "addCircles" : addCirclesCallback
  }
};

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.

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

Dodawanie okręgu