Namespace: ILITEAPI

ILITEAPI

Główny moduł imapLiteApi zawiera tworzenie iframe + metody komunikacji między różnymi stronami(postMessage w celu uniknięcia crossDomain)
Source:

Methods

<static> deleteMarker(id, deleteTime)

Usuwa marker o identyfikatorze id z mapy.
Parameters:
Name Type Argument Description
id String Identyfikator markera na mapie który zostanie usunięty
deleteTime Int <optional>
Czas w ms, po którym zostanie usunięty marker z mapy. Brak oznacza natychmiastowe usuniecie.
Source:

<static> geolocalize(obj)

Uruchamia geolokalizację
Parameters:
Name Type Argument Description
obj Object <optional>
Działa podobnie, jak narzędzie geolokalizacji wywołane z menu aplikacji. Jedyną różnicą jest to, że jeśli nie zadamy do tej metody żadnego parametru, to wynik lokalizacji pojawi się na mapie i mapa zostanie wycentrowana na nim , ale nie przybliży się do niego. Aby mapa się przybliżyła, do punktu lokalizacji to trzeba do metody podać parametr w postaci: {„scale”:2000}
Source:

<static> init(initCfg, callback)

Metoda która tworzy widok aplikacji z mapą w elemencie div strony html, o podanym identyfikatorze.
Parameters:
Name Type Argument Description
initCfg Object Obiekt json z opcjami startowymi aplikacji
Properties
Name Type Argument Description
divId String identyfikator(atrybut id) elementu na stronie html, na której odbywa się osadzania imapLite.
width Int | String Szerokość div z mapą w postaci liczby lub np. „100%”
height Int | String Wysokość div z mapą w postaci liczby lub np. „100%”
activeGpMaps Array <optional>
lista dostępnych kompozycji mapowych – tablica identyfikatorów kompozycji odnoszących się do kompozycji zdefiniowanych w elemencie gpmaps w pliku konfiguracyjnym aplikacji (cfg.json)
activeGpMapId String <optional>
identyfikator kompozycji która ładuje się jako pierwsza(startowa kompozycja) – odnosi się do wybranej kompozycji zdefiniowanej w elemencie gpmaps w pliku konfiguracyjnym aplikacji (cfg.json)
activeGpActions Array <optional>
lista dostępnych akcji – tablica identyfikatorów akcji odnoszących się do akcji zdefiniowanych w elemencie gpactions w pliku konfiguracyjnym aplikacji (cfg.json)
scale Int <optional>
startowy poziom skalowy mapy
marker Object | Array <optional>
startowy punkt do którego centruje się mapa. Przykład poniżej. Zamiast pojedynczego markera można podać tablicę takich obiektów. Wtedy na mapie pojawi się więcej niż jeden marker(jeśli tablica będzie zawierać więcej niż jeden obiekt).Obiekt zawiera opcje dymku.
Properties
Name Type Argument Default Description
title String <optional>
tytuł dymka
content String <optional>
zawartość dymka(prosty html, ze znacznikami <b> i <a>)
show Bool <optional>
pokazanie się automatycznie dymka, po utworzeniu markera
deleteTime int <optional>
-1 Czas po którym zostanie usunięty marker z mapy; brak oznacza brak automatycznego usunięcia markera
id String <optional>
'1' Identyfikator markera. Służy on do usunięcia konkretnego markera z mapy. Jednak obecna wersja pozwala ustawienie jednego markera na mapie, dlatego ten parametr może na razie być pomijany.
initialExtent Object <optional>
Extent startowy mapy. Przykład poniżej.
useMenu Bool <optional>
false – wyłączy pokazywanie menu na mapce; domyślnie true;
selection Array <optional>
Obiekt do ustawiania selekcji po inicjalizacji mapy.
Properties
Name Type Description
onlyPreview Bool true – włacza tryb wyświetlania mapy z selekcja bez możliwości jej zmiany poprzez klikanie na mapie
ids Array to tablica zmienna typu string, a dokładnie identyfikatorów; jest wartość pola typu oidField, np. OBJECTID na warstwie; jedna zmienna, może być grupą wartości wymienionych po przecinku np.; "ids":["1,2,3,4,5,6,7,8,9,10", „11”,”12”]
id String identyfikator warstwy pod którą w aplikacji zostanie załadowana warstwa z selekcjami
oidField String nazwa pola będącego identyfikatorem obiektu na warstwie
oidFieldType String string/numer – określa typ pola będącego identyfikatorem na warstwie
url String url do serwisu z warstwa do selekcji(z niej sa pobierane obiekty podane w ids)
geometryType String point/poligon/polyline; typ geometrii warstwy
zoomToSelect Bool true – oznacza że jeśli zaznaczymy obszar to mapa się do niego przybliży
gpplugins Array <optional>
Jeśli chcemy dołączyć jakiś plugin, a nie mamy go dołączonego w konfiguracji iMapLite, to możemy go dodać podczas inicjonowania mapy, właśnie poprzez podanei tablicy pluginów.
callback callback <optional>
Jest to funkcja javascript, która będzie wykonana po załadowaniu API oraz wyświetleniu mapy.
Source:
Examples

Przykładowy definicji markera

"center" : {
      "x" :  8437470,
      "y" :   5881868,
      "scale" : 10000,
      "title" : „tytuł dymka”,
      "content" : „opis dymka”,
      "show" : true
     }

Przykładowy definicji startowego extentu mapy

"initialExtent" : {
      "xmin" :  8437470,
      "ymin" :   5881868,
      "xmax" : 8449579,
      "ymax" : 5895526        
     }

<static> searchAddress(search, opts)

Wyszukuje adres lub listę adresów spełniająca zadane parametry wyszukiwania. W przypadku istnienia jednego wyniku następuje wstawienia markera/pinezki w wyszukanym punkcie. W przypadku istnienia wielu wyników, konieczny jest wybór rezultatu z listy. W wybranek lokalizacji następuje wstawienie markera/pinezki.
Parameters:
Name Type Argument Description
search String | Object Parametr podawany w postaci pełnego tekstu lub w postaci obiektu. Np: „Wrocław Legnicka 22” lub {"city" : "Wrocław","street" : "Legnicka","number" : “22”}
opts Object <optional>
Jeśli ustawimy zmienną show na true to pokaże się również dymek. Zastąpi on dymek, który ewentualnie był włączony wcześniej (wyszukanie adresu lub wstawienie startowego markera).
Properties
Name Type Argument Default Description
title String <optional>
tytuł dymka; przy wyszukiwaniu brak opcji powoduje wyświetlenie standardowego opisu adresu
content String <optional>
zawartość dymka(prosty html, ze znacznikami <b> i <a>);przy wyszukaniu adresu brak content oznacza standardowy opis dla adresu.
show Bool <optional>
pokazanie się automatycznie dymka, po utworzeniu markera
deleteTime int <optional>
-1 Czas po którym zostanie usunięty marker z mapy; brak oznacza brak automatycznego usunięcia markera
id String <optional>
'1' Identyfikator markera. Służy on do usunięcia konkretnego markera z mapy. Jednak obecna wersja pozwala ustawienie jednego markera na mapie, dlatego ten parametr może na razie być pomijany.
Source:

<static> searchManyObjects(search, opts)

Wyszukuje naraz wiele obiektów(np. adresy).
Parameters:
Name Type Description
search Array Jest to tablica obiektów które podajemy w metodzie searchAddress. Jedyna różnicą jest dodatkowy parametr podawany w obiekcie opts.
opts Object
Properties
Name Type Description
layerDesc String identyfikator warstwy; służy do dodatkowego skonfigurowania wyszukiwania; odnosi się do pozycji configu w obiekcie gplayers; dzięki temu możemy wskazać np. url do usługi;
Source:
Example

Przykład parametrów wywołania

[
 {
     "search" : "Wrocław Legnicka 20",
     "opts":
         {
             "layerDesc":"geopard.Adresy"
         }
 },
 {
     "search" : "Wrocław Rynek 10",
     "opts":
         {
             "layerDesc":"geopard.Adresy"
         }
 },
 {
     "search": "Wroclaw Grabiszyńska 100",
     "opts":
         {
             "show":true,
             "layerDesc":"geopard.Adresy"
         }
 }
]

<static> showManyMarker(markers)

Wstawia naraz wiele markerów o w podanych punktach x,y
Parameters:
Name Type Description
markers Array Jest to tablica obiektów o postaci znanej z metody showMarker
Source:
Example

Przykład wartosci parametru markres

[
 {
 "x":591920.9699999997, 
 "y":259048.22000000067,
 "sr":2180,
 "opts":{
     "id" : "marker1",
     "title" : "marker nr 1",
     "content" : "marker nr 1 - tresc",
     "show":true,
     "center":false
     }
 },
 {
 "x":521920.9699999997, 
 "y":239048.22000000067,
 "sr":2180,
 "opts":{
     "id" : "marker2",
     "title" : "marker nr 2",
     "content" : "marker nr 2 - tresc"
     }
 }
]

<static> showMarker(x|marker, y, opts, sr)

Wstawia w punkcie o współrzędnych x i y marker/pinezkę
Parameters:
Name Type Argument Description
x|marker Int | Object Współrzędna x markera.|Jako parametr wstawiamy obiekt json z przynajmniej jednym atrybutem. Musi to być atrybut id. Np. ILITEAPI.showMarker({"id" : "marker0"}). Takie wywołanie spowoduje wycentrowanie mapy do punktu, w którym wstawiony jest marker o zadanym identyfikatorze. Oprócz id, można podać scale, co spowoduje przybliżenie się do danego punktu w danej skali.
y Int Współrzędna y markera.
opts Object <optional>
Properties
Name Type Argument Default Description
id String <optional>
'1' identyfikator markera; Jest parametrem wymaganym w przypadku kiedy np. inicjalizujemy aplikację poprzez pokazanie markera na starcie aplikacji i chcemy go potem usunąć używając metody deleteMarker. Brak id, spowoduje automatyczne nadanie identyfikatora w aplikacji.
title String <optional>
tytuł dymka; przy wyszukiwaniu brak opcji powoduje wyświetlenie standardowego opisu adresu
content String <optional>
zawartość dymka(prosty html, ze znacznikami <b> i <a>);przy wyszukaniu adresu brak content oznacza standardowy opis dla adresu.
show Bool <optional>
pokazanie się automatycznie dymka, po utworzeniu markera
deleteTime int <optional>
-1 Czas po którym zostanie usunięty marker z mapy; brak oznacza brak automatycznego usunięcia markera
show Bool Jeśli ustawimy zmienną show na true to pokaże się również dymek. Zastąpi on dymek, który ewentualnie był włączony wcześniej(poprzez inicjalizację API, wyszukanie adresy lub wstawienie startowe markera).
sr Int <optional>
odwzorowanie; dopuszczalne wartości: 2180(układ 1992),4326(WGS84)
Source: