Klasa odpowiedzialna za wyszukiwanie informacji na mapie, aktualnie punktów adresowych.
EMAPI. | Klasa odpowiedzialna za wyszukiwanie informacji na mapie, aktualnie punktów adresowych. |
Functions | |
EMAPI. | Konstruktor nowej instancji klasy EMAPI.Finder. |
destroy | Niszczy obiekt klasy EMAPI.Finder. |
setCountry | Ustawia kontekst kraju, w którym następuje wyszukiwanie danych. |
setLanguage | Ustawia kontekst językowy dla wyników zwracanych przez funkcje search i geocode. |
getCountry | Zwraca kod ccTLD kraju aktualnie ustawionego dla wyszukiwania. |
getLanguage | Zwraca kontekst językowy aktualnie ustawiony dla wyszukiwania. |
search | Wyszukuje punkty adresowe zgodne z podanym adresem. |
geocode | Wyszukuje punkty adresowe zgodne z podanymi danymi adresowymi. |
getCoordinates | Pobiera lokalizację na mapie jednego z punktów adresowych wyszukanych za pomocą funkcji search. |
degeocode | Wyszukuje informacje geograficzne dla punktów o podanych współrzędnych. |
getObjectCategories | Zwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów statycznych klienta. |
getPOICategories | Zwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów POI. |
searchObjects | Wyszukuje obiekty statyczne klienta. |
searchPOI | Wyszukuje obiekty POI. |
Konstruktor nowej instancji klasy EMAPI.Finder.
obj | {Object} Obiekt klasy EMAPI.Map lub tekstowy token klienta. |
options | {Object} Obiekt z dodatkowymi parametrami instancji klasy. |
search: function ( address, callback, options )
Wyszukuje punkty adresowe zgodne z podanym adresem. Dane przekazywane do podstawianej w drugim parametrze funkcji zawierają listę dopasowanych punktów adresowych (geocodeInfoArray) zawierających:
Jeżeli któryś z elementów nie występuje w wynikowym punkcie adresowym, oznacza to, że został odrzucony podczas wyszukiwania.
address | {String} Adres do wyszukania w formacie ”(miejscowość|kod)[,ulica [numer]][;(kod|adm1[,adm2[,adm3]])]”, co oznacza, że na początku znajduje się miejscowość albo kod pocztowy, następnie opcjonalnie po przecinku ulica z ewentualnym numerem i dalej opcjonalnie po średniku kod pocztowy albo lista do trzech obszarów administracyjnych (od najwyższego do najniższego poziomu) oddzielonych przecinkami. Wielkość liter nie ma znaczenia. |
callback | {Function} Funkcja obsługi wyników wyszukiwania. |
options | {Object} Obiekt z dodatkowymi parametrami wyszukiwania: elasticSearch (informacja czy zastosować wyszukiwanie elastyczne, tzn. czy parametr address może zawierać dane niesformatowane podawane w dowolnej kolejności, domyślnie false) |
geocode: function ( country, city, zip, street, streetnumber, callback )
Wyszukuje punkty adresowe zgodne z podanymi danymi adresowymi. Dane przekazywane do podstawianej w drugim parametrze funkcji zawierają listę dopasowanych punktów adresowych (geocodeInfoArray) zawierających:
Jeżeli któryś z elementów nie występuje w wynikowym punkcie adresowym, oznacza to, że został odrzucony podczas wyszukiwania.
country | {String} Pełna nazwa kraju. |
city | {String} Nazwa miejscowości. |
zip | {String} Kod pocztowy. |
street | {String} Nazwa ulicy. |
streetnumber | {String} Numer budynku. |
callback | {Function} Funkcja obsługi wyników wyszukiwania. |
getCoordinates: function( index, callback )
Pobiera lokalizację na mapie jednego z punktów adresowych wyszukanych za pomocą funkcji search. Dane przekazywane do podstawianej w drugim parametrze funkcji zawierają element o strukturze zgodnej z przekazywaną przez funkcję search, przy czym zwracany jest odpowiedni kod błędu (result: 0 = ok, 1 = niepoprawny indeks pozycji w liście wyników).
index | {Integer} Pozycja żądanego elementu z listy wyników wyszukiwania (wartość z zakresu 0-[liczba wyników pomniejszona o 1]) |
callback | {Function} Funkcja obsługi wyniku wyszukiwania. |
degeocode: function( points, zoom, callback )
Wyszukuje informacje geograficzne dla punktów o podanych współrzędnych. Dane przekazywane do podstawianej funkcji w postaci tablicy informacji adresowych degeocodeInfoArray zawierają:
Pola foundLength zawierają odległość w metrach znalezionego obiektu od danego punktu. Dodatkowo przekazywany jest kod błędu (result: 0 = ok, 1 = brak danych).
points | {Array(EMAPI.LonLat)} Punkty do zdegeokodowania. |
zoom | {Integer} Powiększenie mapy, które ma być użyte dla degeokodowania informacji (wartość z zakresu 0-17). |
callback | {Function} Funkcja obsługi zwracanych danych. |
getObjectCategories: function( callback )
Zwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów statycznych klienta. Dane przekazywane do podstawianej funkcji zawierają tablicę kategorii zawierających:
callback | {Function} Funkcja obsługi parametrów kategorii. |
getPOICategories: function( callback )
Zwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów POI. Dane przekazywane do podstawianej funkcji zawierają tablicę kategorii zawierających:
callback | {Function} Funkcja obsługi parametrów kategorii. |
searchObjects: function( categoryNames, searchText, lonLat, objectCount, queryRadius, objectIDs, callback )
Wyszukuje obiekty statyczne klienta. Dane przekazywane do podstawianej w drugim parametrze funkcji zawierają listę znalezionych obiektów (searchObjectArray) zawierających:
Uwzględniane są wszystkie parametry przekazane do funkcji (koniunkcja warunków).
categoryIds | {String} Lista podkategorii, w których ma nastąpić wyszukiwanie (id podkategorii oddzielone średnikami). |
searchText | {String} Szukana fraza określająca poszukiwane obiekty. Wielkość liter nie ma znaczenia. |
lonLat | {EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne geograficzne punktu centralnego, względem którego następuje wyszukiwanie. |
objectCount | {Integer} Maksymalna liczba oczekiwanych wyników (nie może być większa niż 50). |
queryRadius | {Integer} Maksymalny promień wyszukiwania (w metrach). |
objectIDs | {String} Lista konkretnych identyfikatorów żądanych obiektów (identyfikatory oddzielone średnikami). |
callback | {Function} Funkcja obsługi wyników wyszukiwania. |
searchPOI: function( categoryNames, searchText, lonLat, objectCount, queryRadius, objectIDs, callback )
Wyszukuje obiekty POI. Dane przekazywane do podstawianej w drugim parametrze funkcji zawierają listę znalezionych obiektów (searchObjectArray) zawierających:
Uwzględniane są wszystkie parametry przekazane do funkcji (koniunkcja warunków).
categoryIds | {String} Lista podkategorii, w których ma nastąpić wyszukiwanie (id podkategorii oddzielone średnikami). |
searchText | {String} Szukana fraza określająca poszukiwane obiekty. Wielkość liter nie ma znaczenia. |
lonLat | {EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne geograficzne punktu centralnego, względem którego następuje wyszukiwanie. |
objectCount | {Integer} Maksymalna liczba oczekiwanych wyników (nie może być większa niż 50). |
queryRadius | {Integer} Maksymalny promień wyszukiwania (w metrach). |
objectIDs | {String} Lista konkretnych identyfikatorów żądanych obiektów (identyfikatory oddzielone średnikami). |
callback | {Function} Funkcja obsługi wyników wyszukiwania. |
Niszczy obiekt klasy EMAPI.Finder.
destroy: function()
Ustawia kontekst kraju, w którym następuje wyszukiwanie danych.
setCountry: function( country )
Ustawia kontekst językowy dla wyników zwracanych przez funkcje search i geocode.
setLanguage: function ( language )
Zwraca kod ccTLD kraju aktualnie ustawionego dla wyszukiwania.
getCountry: function()
Zwraca kontekst językowy aktualnie ustawiony dla wyszukiwania.
getLanguage: function ()
Wyszukuje punkty adresowe zgodne z podanym adresem.
search: function ( address, callback, options )
Wyszukuje punkty adresowe zgodne z podanymi danymi adresowymi.
geocode: function ( country, city, zip, street, streetnumber, callback )
Pobiera lokalizację na mapie jednego z punktów adresowych wyszukanych za pomocą funkcji search.
getCoordinates: function( index, callback )
Wyszukuje informacje geograficzne dla punktów o podanych współrzędnych.
degeocode: function( points, zoom, callback )
Zwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów statycznych klienta.
getObjectCategories: function( callback )
Zwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów POI.
getPOICategories: function( callback )
Wyszukuje obiekty statyczne klienta.
searchObjects: function( categoryNames, searchText, lonLat, objectCount, queryRadius, objectIDs, callback )
Wyszukuje obiekty POI.
searchPOI: function( categoryNames, searchText, lonLat, objectCount, queryRadius, objectIDs, callback )