Główny moduł imapLiteApi który jest rozszerzony o dodatkowe funkcje po dodaniu do strony pliku imapLiteApi-coreEx.js oraz podpięciu plugina clusterLayer
- Source:
Methods
-
<static> add(layerId, obj)
-
Dodaje do warstwy nowy obiekt
Parameters:
Name Type Description layerId
String identyfikator warstwy obj
Object obiekt do dodania Properties
Name Type Description geometry
Object geometria obiektu {x,y} attributes
Object atrybuty obiektu {nazwa:wartość, nazwa:wartość} - Source:
-
<static> addCustomCss(url)
-
Funkcja pozwalająca na dodanie do strony mapy własnych styli CSS bezpośrednio z adresu url
Parameters:
Name Type Description url
String link do pliku css - Source:
-
<static> addCustomStyle(styleString)
-
Funkcja pozwalająca na dodanie do strony mapy własnych styli CSS bezpośrednio poprzez paramter
Parameters:
Name Type Description styleString
String string zawierający style - Source:
- Tutorials:
-
<static> addGraphic(g)
-
Dodaje do mapy grafikę użytownika Wymaga podpięcia pluginu addGraphic
Parameters:
Name Type Description g
Object obiekt z grafiką do dodania do mapy w formacie JSON. Przykłady formatów: http://help.arcgis.com/en/arcgisserver/10.0/apis/rest/geometry.html - Source:
-
<static> addLayer(cfg)
-
Dodaje warstwę do mapy
Parameters:
Name Type Description cfg
Object obiekt zawierający wszystie dane potrzebne do wyświetlenia warstwy Properties
Name Type Argument Default Description id
String identyfikator warstwy do dodania name
String nazwa warstwy (np: na legendzie czy na liście) data
Object dane warswy Properties
Name Type Description geometry
Object geometria obiektu Properties
Name Type Description x
Float współrzędna x y
Float współrzędna y attributes
Object atrybuty obiektu w postaci słownika {nazwa:wartość, nazwa:wartość} idField
String nazwa pola które będzie służyc jako identyfiaktor obiektów renderer
JSON renderer służący do rysowania danych na mapie clusterRenderer
JSON renderer służący do rysowania danych klastrowanych na mapie groupDistance
Int <optional>
100 maksymalna odległość pomiędzy obiektami na ekranie w pikselach która skutkuje grupowaniem tych obiektów maxClusterScale
Int <optional>
100000 maksymalna skala do której będzie działało klastrowanie groupAttribute
String <optional>
Nazwa pola po którym dodatkowo przy klastrowaniu bedzie odbywało się grupowanie (np: nazwa województwa, wtedy przy dostatecznie małej skali na mapie bedzie po 1 klastrze dla każdego województwa) popupTemplate
Int <optional>
szablon okna pokazwyanego po kliknięciu na obiekt - Source:
- Tutorials:
-
<static> addMapModule(cfg, callback)
-
Pozwala na podpięcie nowego modułu do mapy Wymaga podpięcia pluginu addService
Parameters:
Name Type Description cfg
Object konfiguracja nowego modułu Properties
Name Type Description id
String identyfikator nowego modułu label
String nazwa nowego modułu widoczna na liście mapservices
Array lista serwisów do dodania do mapy (zobacz funkcję addMapService) callback
callback funkcja wywoływana po dodaniu modułu do mapy z 1 parametrem - Source:
- Tutorials:
-
<static> addMapService(cfg, callback)
-
Pozwala na dodanie do istniejącego modułu nowego serwisu mapowego Wymaga podpięcia pluginu addService
Parameters:
Name Type Description cfg
Object konfiguracja nowego serwisu Properties
Name Type Description id
String identyfikator modułu do którego dodany bedzie serwis mapService
Object konfiguracja serwisu do dodania Properties
Name Type Argument Description mapId
String identyfiaktor serwisu index
Int indeks serwisu w module visible
Bool <optional>
czy serwis ma być widoczny alpha
Float <optional>
przezroczystość serwisu type
String typ serwisu: [titled, dynamic, WMS] serviceUrl
String adres serwisu minScale
Int <optional>
minimalna skala przy której wyświetla się serwis maxScale
Int <optional>
maksymalna skala przy której wyświetla się skala callback
callback funkcja wywoływana po dodaniu modułu do mapy z 1 parametrem - Source:
-
<static> addObject(compositionId, layerId, newObject, callback)
-
Dodaje nowy obiekt do warstwy, włacznie z zapisaniem go do bazy
Parameters:
Name Type Description compositionId
String identyfikator kompozycji layerId
String identyfikator warstwy newObject
Object obiekt do zapisania callback
callback funkcja zwrotna wywoływana po zapisaniu obiektu do bazy z wynikami - Source:
-
<static> addObjects(compositionId, layerId, newObjects, callback)
-
Dodaje nowe obiekty do warstwy, włacznie z zapisaniem ich do bazy
Parameters:
Name Type Description compositionId
String identyfikator kompozycji layerId
String identyfikator warstwy newObjects
Array tablica obiektów do zapisania callback
callback funkcja zwrotna wywoływana po zapisaniu obiektów do bazy z wynikami - Source:
-
<static> changeRenderer(cfg)
-
Pozwala na zmanę wczejśniej dodanego renderera
Parameters:
Name Type Description cfg
Object obiekt z danymi Properties
Name Type Description layerId
String identyfikator warstwy renderer
JSON renderer służący do rysowania danych na mapie clusterRenderer
JSON renderer służący do rysowania danych klastrowanych na mapie - Source:
-
<static> clearGraphics()
-
Usuwa z mapy grafikę użytownika Wymaga podpięcia pluginu addGraphic
- Source:
-
<static> deleteObject(compositionId, layerId, objectId, callback)
-
Usuwa obiekt z warswy, włacznie z usunięciem go do bazy
Parameters:
Name Type Description compositionId
String identyfikator kompozycji layerId
String identyfikator warstwy objectId
Object identyfikator obiekt do usunięcia callback
callback funkcja zwrotna wywoływana po usunięciu obiektu z bazy z wynikami - Source:
-
<static> flash(layerIdOrObj, id, delay)
-
Podświetla obiekt na wybranej warstwie
Parameters:
Name Type Argument Description layerIdOrObj
String | Object identyfikator wastwy lub obiekt ze współrzędnymi Properties
Name Type Description x
Float współrzędna x y
Float współrzędna x id
Int <optional>
identyfikator obiektu w warstwie layerId, podajemy tylko jeśli podawaliśmy layerId w poprzednim parametrze delay
int opóźnienie w ms podświetlenia - Source:
- Tutorials:
-
<static> getCenter(callback)
-
Fukcja do pobierania akutalnego środka mapy podawane w układzie w układzie współrzędnym mapy np: 2180
Parameters:
Name Type Description callback
function funkcja która w 1 parametrze będzie miała przekazany środek mapy jako 2 elementową tablicę - Source:
-
<static> getCenterAndScale(callback)
-
Fukcja do pobierania akutalnego środka mapy podawane w układzie w układzie współrzędnym mapy np: 2180 oraz skali mapy
Parameters:
Name Type Description callback
function funkcja która w 1 parametrze będzie miała przekazany obiekt ze środekiem mapy jako 2 elementową tablicę oraz skalę - Source:
-
<static> getComposition(id, callback)
-
Pobiera konfigurację oraz dane dla zadanej kompozycji
Parameters:
Name Type Description id
String identyfikator kompozycji do pobrania callback
ILITEAPI~getCompositionCallback funkcja zwrotna z danymi kompozycji - Source:
-
<static> getCompositionList(callback)
-
Zwraca listę dostępnych kompozycji dla aktualnie zalogowanego użytkownika
Parameters:
Name Type Description callback
ILITEAPI~getCompositionListCallback funkcja zwrotna zawierająca listę kompozycji - Source:
-
<static> getExtent(callback)
-
Funkcja do pobierania aktualnego zasięgu mapy podawanego w układzie współrzędnym mapy np: 2180
Parameters:
Name Type Description callback
ILITEAPI~getExtentCallback funkcja która w 1 parametrze będzie miała przekazany zasięg mapy - Source:
- Tutorials:
-
<static> getFilters()
-
Funkcja pobierająca filtrowanie dla warstw
- Source:
-
<static> getMapModules(callback)
-
Pozwala na pobranie listy aktulanych modułów mapowych Wymaga podpięcia pluginu addService
Parameters:
Name Type Description callback
callback funkcja z wynikową listą dostępnych modułów w formacie [{id, name}, ...] - Source:
-
<static> getMapSize(callback)
-
Pobiera rozmiar mapy (w iFrame)
Parameters:
Name Type Description callback
callback funkcja zwrotna z rozmiarem mapy w 1 parametrze - Source:
-
<static> getParameterByName(name) → {String}
-
Funkcja pozwalająca na pobranie wartości parametru pobranego z aktualnego adresu URL
Parameters:
Name Type Description name
String nazwa parametru - Source:
Returns:
wartość parametru- Type
- String
-
<static> getQueryActiveMapModule() → {String}
-
Funkcja zwracająca parametr 'actMap' - activeMapId przekazany w parametrach queryString
- Source:
Returns:
wartość parametru actMap- Type
- String
-
<static> getQueryCenter() → {String}
-
Funkcja zwracająca parametr 'ce' - center przekazany w parametrach queryString
- Source:
Returns:
wartość parametru ce- Type
- String
-
<static> getQueryCenterAndScale() → {String}
-
Funkcja zwracająca parametr 'cesc' - center i scale przekazany w parametrach queryString
- Source:
Returns:
wartość parametru cesc- Type
- String
-
<static> getQueryExtent() → {String}
-
Funkcja zwracająca parametr 'e' - extent przekazany w parametrach queryString
- Source:
Returns:
wartość parametru e- Type
- String
-
<static> getQueryMapModules() → {String}
-
Funkcja zwracająca parametr 'maps' - activeMaps przekazany w parametrach queryString
- Source:
Returns:
wartość parametru maps- Type
- String
-
<static> getQueryScale() → {String}
-
Funkcja zwracająca parametr 'sc' - scale przekazany w parametrach queryString
- Source:
Returns:
wartość parametru sc- Type
- String
-
<static> getScale(callback)
-
Fukcja do pobierania aktualnej skali mapy
Parameters:
Name Type Description callback
function funkcja która w 1 parametrze będzie miała przekazaną skalę mapy - Source:
-
<static> getVisibleIds(callback)
-
Zwraca listę widocznych obiektów na ekranie nadaje sie do pobierania danych klastrowanych po stronie użytkownika
Parameters:
Name Type Description callback
ILITEAPI~getVisibleIdsCallback funkcja która w 1 paramterze będzie miała słownik gdzie kluczem będzie identyfikator warstwy a wartością będzie lista identyfikatorów obiektów z tej warstwy - Source:
- Tutorials:
-
<static> getVisibleIds(showClusters, callback)
-
Zwraca listę widocznych obiektów na ekranie oraz jesli dla warstwy było ustawione klastrowanie serwerowe zwraca również dane
Parameters:
Name Type Description showClusters
bool określa czy w zwracanych danych maja być widoczne całe dane czy dane zklastrowane (tak jak widać je na mapie). Dla warstwy z klastrowaniem serwerowym zawsze zwracane są dane klastrowane callback
ILITEAPI~getVisibleDataCallback funkcja która w 1 paramterze będzie miała obiekt ktory posiada klucz ids które jest słownikiem gdzie kluczem będzie identyfikator warstwy a wartością będzie lista identyfikatorów obiektów z tej warstwy, drugim kluczem zwracanego obiketu jest data, który jest słownikem z danymi - dla warstwy klastrowanej serwerowo - Source:
-
<static> hideLoader()
-
Ukrywa na mapie "spinner" z tekstem Wymaga podpięcia pluginu addGraphic
- Source:
-
<static> lastAdd(compositionId, callback)
-
Zwraca czas ostatniego dodania obiektu dla wybranej kompozycji z IP użytkownika (pobranego z request)
Parameters:
Name Type Description compositionId
String identyfikator kompozycji callback
callback funkcja zwrotna w której zwracany jest czas ostatniego dodania obiektu dla IP użytkownika (pobranego z request) - Source:
-
<static> loadComposition(id, options)
-
Wyświetla na mapie kompozycję o danym id
Parameters:
Name Type Description id
String identyfikator kompozycji do załadowania options
Object dodatkowe parametry Properties
Name Type Argument Default Description ignoreExtent
bool <optional>
false czy po wyczytaniu danych pomijać parametr extent ustawiony w metadanych filter
Object <optional>
domyślny filtr ustawiony na starcie Properties
Name Type Argument Description layerId
Array <optional>
format zapisu wartości - [{op:string, field:string, args:[]}] refreshInterval
Number <optional>
częstotliwość odświeżania danych w sekundach - Source:
-
<static> loadCompositionWithCallback(id, callback, options)
-
Wyświetla na mapie kompozycję o danym id oraz wraca dane tej kompozycji
Parameters:
Name Type Description id
String identyfikator kompozycji do załadowania callback
callback funkcja wywoływana po załadowniu kompozycji z 1 parametrem z danymi kompozycji options
Object dodatkowe parametry Properties
Name Type Argument Default Description initialExtent
Object <optional>
początkowy extent mapy Properties
Name Type Description xmin
Number ymin
Number xmax
Number xmax
Number spatialReference
Object Properties
Name Type Description wkid
Number well-known ID ignoreExtent
bool <optional>
false czy po wyczytaniu danych pomijać parametr extent ustawiony w metadanych filter
Object <optional>
domyślny filtr ustawiony na starcie Properties
Name Type Argument Description layerId
Array <optional>
format zapisu wartości - [{op:string, field:string, args:[]}] refreshInterval
Number <optional>
częstotliwość odświeżania danych w sekundach layers
Object <optional>
słownik gdzie kluczem jest identyfikator warstwy a wartością obiekt {popupTemplate: '...', listTemplate: '...', editTemplate: '...'} - pozwala na nadpisywanie szablonów zdefiniowanych w edytorze kompozycji - Source:
-
<static> publicAddObject(compositionId, layerId, newObject, callback)
-
Dodaje nowy obiekt do warstwy, włacznie z zapisaniem go do bazy, funkcja może być wykonana tylko jeśli w kompozycji jest zaznaczona funkcja "publiczne dodawanie" wtedy uzytkownik bez żadnych uprawnień może dodawać obiekty
Parameters:
Name Type Description compositionId
String identyfikator kompozycji layerId
String identyfikator warstwy newObject
Object obiekt do zapisania callback
callback funkcja zwrotna wywoływana po zapisaniu obiektu do bazy z wynikami - Source:
-
<static> redraw(layerId)
-
Wymusza przerysowanie podanej warstwy
Parameters:
Name Type Description layerId
String identyfikator warstwy - Source:
-
<static> reinitEx()
-
Jesli po usunięciu mapy z DOM i dodaniu jej ponownie nie działają zdarzenia, to należy wywołać tą metodę
- Source:
-
<static> remove(layerId, id)
-
Usuwa obiekt o podanym identyfikatorze z podenej warstwy
Parameters:
Name Type Description layerId
String identyfikator warstwy id
Int identyfikator obiektu - Source:
-
<static> removeLayer(layerId)
-
Usuwa warstwę z mapy
Parameters:
Name Type Description layerId
String guid warstwy do usunięcia - Source:
-
<static> removeMapModule(id, callback)
-
Usuwa wybrany moduł z listy dostępnych modułów i odświeża mapę Wymaga podpięcia pluginu addService
Parameters:
Name Type Description id
String identyfikator modułu do usunięcia callback
callback funkcja z wynikową listą dostępnych modułów w formacie [{id, name}, ...] - Source:
-
<static> searchUserData(searchStr, callback)
-
Funkcja do przeszukwania pełnotekstowego danych dodanych do mapy
Parameters:
Name Type Description searchStr
String szukany tekst callback
ILITEAPI~searchUserDataCallback funkcja z wynikami wyszukania - Source:
- Tutorials:
-
<static> setEnableCustomClick(layerId, state)
-
Funkcja włączajaca/wyłączająca generowanie zdarzenia onClick na warstwie. Pozwala na podpięcie własnej obsługi podpowiedzi.
Parameters:
Name Type Description layerId
String identyfikator warstwy state
Bool stan wł/wył zdarzenia click na warstwie - Source:
-
<static> setFilterForLayer(layerId, filter)
-
Funkcja ustawiająca filtrowanie dla danej warstwy
Parameters:
Name Type Description layerId
String identyfikator warstwy filter
Object obiekt z wartościami filtra typu {op:"eq", args:[10], field: "typ"} dostępne operatory to: eq - 'field == args', neq - 'field != args', lt - 'field < args', lte - 'field <= args', gt - 'field > args', gte - 'field >= args', in - 'field in (args)', nin - 'field not in (args), startsWith - 'field startsWith (args)', endsWith - 'field endsWith (args)', constains - 'field contains (args)', bAnd - 'field & (args)' - binary operator, bOr - 'field | (args)' - binary operator, - Source:
-
<static> setMapCursor()
-
Ustawia kursor myszy dla mapy
- Source:
-
<static> setMapModule(id, callback)
-
Ustawia przekazany moduł jako aktywny i odświeża mapę Wymaga podpięcia pluginu addService
Parameters:
Name Type Description id
String identyfikator modułu callback
callback funkcja z wynikiem operacji - Source:
-
<static> showBookmarksWindow()
-
Wyświetla okno z zakładkami przestrzennymi Wymaga podpięcia pluginu bookmarks
- Source:
-
<static> showLoader(msg)
-
Wyświetla na mapie "spinner" z tekstem Wymaga podpięcia pluginu addGraphic
Parameters:
Name Type Description msg
String tekst pod ikoną - Source:
-
<static> showPopup(layerId, id)
-
Dla danego obiektu na wybranej warstwie wyświetla okno z dymkiem i informacja o obiekcie
Parameters:
Name Type Description layerId
String identyfikator wastwy id
Int identyfikator obiektu w warstwie layerId - Source:
- Tutorials:
-
<static> update(layerId, id, newObject)
-
Aktualizuje obiekt o podanym identyfikatorze z podenej warstwy
Parameters:
Name Type Description layerId
String identyfikator warstwy id
Int identyfikator obiektu newObject
Object nowy obiekt Properties
Name Type Description geometry
Object geometria obiektu Properties
Name Type Description x
Float współrzędna x y
Float współrzędna y attributes
Object atrybuty obiektu w postaci słownika {nazwa:wartość, nazwa:wartość} - Source:
-
<static> updateObject(compositionId, layerId, updatedObject, callback)
-
Aktualizuje obiekt w warswie, włacznie z zapisaniem go do bazy
Parameters:
Name Type Description compositionId
String identyfikator kompozycji layerId
String identyfikator warstwy updatedObject
Object obiekt do zaktualizowania callback
callback funkcja zwrotna wywoływana po zaktualizowaniu obiektu do bazy z wynikami - Source:
-
<static> zoomTo(obj)
-
Powiększa mapę w zależności od typu przekazanego parametru do obszaru lub wskazanych obiektów
Parameters:
Name Type Description obj
Object można podać obiekt typy extent: {xmin, xmax, ymin, ymax, spatialReference:{wkid}}, lub słownik z identyfikatorami obiektów do ktorych będzie wykonane przybliżenie: {layerId:[id1,id2,id3], layerId2:[id1,id2]} - Source:
- Tutorials:
Examples
{ "xmin": 638902.2299711781, "ymin": 490423.72377461987, "xmax": 640050.5239344328, "ymax": 491019.0374652472, "spatialReference": { "wkid": 2180 } }
{ "4028fb474d675639014d6c20cf4a000f":[ 123, 234 ], "4028fb474d675639014d6c20cf4a0000":[ 11 ] }
Type Definitions
-
ILITEAPI~getCompositionCallback(result)
-
Funkcja zwrotna z 1 parametrem zawierajacym konfigurację oraz dane kompozycji
Parameters:
Name Type Description result
Object Properties
Name Type Description meta
String konfiguracja kompozycji Properties
Name Type Description sharePublic
Bool czy kompozycja jest publiczna czy nie initialExtent
JSON początkowy zasięg dla kompozycji layers
Array tablica z konfuguracją warstw (zobacz funkcję addLayer) data.data
Array słownik z danymi kompozycji - Source:
-
ILITEAPI~getCompositionListCallback(result)
-
Funckja zwrotna z 1 parametrem zawierająca listę dostępnych kompozycji
Parameters:
Name Type Description result
Array lista obiektów z danymi kompozycji - Source:
-
ILITEAPI~getExtentCallback(extent)
-
Funkcja zwrotna z 1 parametrem zawierajacym aktualny zasięg mapy
Parameters:
Name Type Description extent
Object obiekt z zasięgiem mapy Properties
Name Type Description xmin
Float współrzędna x xmax
Float współrzędna x ymin
Float współrzędna y ymax
Float współrzędna y spatialReference
Object obiekt odzworowania Properties
Name Type Description wkid
Int identyfikator odwzorowania (Well Known ID) - Source:
-
ILITEAPI~getVisibleIdsCallback(result)
-
Funkcja zwrotna z 1 parametrem wywoływana w funkcji getVisibleIds
Parameters:
Name Type Description result
Object słownik z obiektami widocznymi na ekranie, gdzie kluczem jest identyfikator warstwy a wartością jest lista identyfikatorów obiektów z tej warstwy - Source:
-
ILITEAPI~searchUserDataCallback(result)
-
Funkcja zwrotna z 1 parametrem zawierajacym aktualny zasięg mapy
Parameters:
Name Type Description result
Object słownik ze znalezionymi obiektami w formacie {layerId:[objectId, objectId], layerId:[objectId,objectId]} Properties
Name Type Description key
String identyfikator warstwy value
Array lista identyfikatorów obiektów z danej warstwy - Source:
Events
-
onClick
-
Zdarzenie wywoływane po naciśnięciu na obiekt dodany przez użytkownika, wywoływane jeśli na danej warstwie ustawione jest setEnableCustomClick
- Source:
Properties:
Name Type Description selectedObject
Object kliknięty obiekt na mapie ze wszystkimi atrybitami tego obiektu Properties
Name Type Description layerId
String identyfikator warstwy -
onExtentChange
-
Zdarzenie wywoływane po zmianie zasięgu mapy
- Source:
-
onMapClick
-
Zdarzenie kliknięcie na mapie (nie na obiektach dodanych do mapy)
- Source:
Properties:
Name Type Description evt
Object parametr dodawany do 1 argumentu przekazywanego w zdarzeniu Properties
Name Type Description mapPoint
Object punkt kliknięcia na mapie (we współrzędnych mapowych) Properties
Name Type Description x
Object współrzędna x y
Object współrzędna y -
onZoom
-
Zdarzenie wywoływane po zmianie parametru zoom mapy
Type:
- Object
- Source: