EMAPI.Finder

Klasa odpowiedzialna za wyszukiwanie informacji na mapie, aktualnie punktów adresowych.

Podsumowanie
EMAPI.FinderKlasa odpowiedzialna za wyszukiwanie informacji na mapie, aktualnie punktów adresowych.
Functions
EMAPI.FinderKonstruktor nowej instancji klasy EMAPI.Finder.
destroyNiszczy obiekt klasy EMAPI.Finder.
setCountryUstawia kontekst kraju, w którym następuje wyszukiwanie danych.
setLanguageUstawia kontekst językowy dla wyników zwracanych przez funkcje search i geocode.
getCountryZwraca kod ccTLD kraju aktualnie ustawionego dla wyszukiwania.
getLanguageZwraca kontekst językowy aktualnie ustawiony dla wyszukiwania.
searchWyszukuje punkty adresowe zgodne z podanym adresem.
geocodeWyszukuje punkty adresowe zgodne z podanymi danymi adresowymi.
getCoordinatesPobiera lokalizację na mapie jednego z punktów adresowych wyszukanych za pomocą funkcji search.
degeocodeWyszukuje informacje geograficzne dla punktów o podanych współrzędnych.
getObjectCategoriesZwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów statycznych klienta.
getPOICategoriesZwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów POI.
searchObjectsWyszukuje obiekty statyczne klienta.
searchPOIWyszukuje obiekty POI.

Functions

EMAPI.Finder

Konstruktor nowej instancji klasy EMAPI.Finder.

Parametry

obj{Object} Obiekt klasy EMAPI.Map lub tekstowy token klienta.
options{Object} Obiekt z dodatkowymi parametrami instancji klasy.

destroy

destroy: function()

Niszczy obiekt klasy EMAPI.Finder.

setCountry

setCountry: function(country)

Ustawia kontekst kraju, w którym następuje wyszukiwanie danych.

Parametry

country{String} Kod ccTLD żądanego kraju.

setLanguage

setLanguage: function (language)

Ustawia kontekst językowy dla wyników zwracanych przez funkcje search i geocode.

Parametry

language{String} 3-literowy skrót kontekstu językowego, np.  POL, ENG, GER, FRE.  Wartość pusta powoduje automatyczny wybór języka wyników.

getCountry

getCountry: function()

Zwraca kod ccTLD kraju aktualnie ustawionego dla wyszukiwania.  Domyślnie ustawiony jest on zgodnie z kodem domeny najwyższego poziomu dla domeny, w której uruchamiany jest skrypt.

Wynik

{String} Kod ccTLD kraju.

getLanguage

getLanguage: function ()

Zwraca kontekst językowy aktualnie ustawiony dla wyszukiwania.

Wynik

{String} Aktualny kontekst językowy wyników wyszukiwania.  Wartość pusta (domyślna) oznacza automatyczny wybór języka wyników.

search

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:

  • miejscowość (city)
  • kod pocztowy (zip)
  • ulica (street)
  • numer (streetNumber)
  • obszary administracyjne adm1, adm2, amd3 (areaName1, areaName2, areaName3)
  • współrzędne geograficzne środka wyszukanego punktu oraz prostokąta otaczającego wyszukany obiekt, np. miejscowość, czy ulicę (middlePoint.longitude, middlePoint.latitude, topLeft.longitude, topLeft.latitude, bottomRight.longitude, bottomRight.latitude)
  • kod błędu (result: 0 = ok, 1 = brak wyników, 2 = zbyt dużo wyników, zwrócono pierwsze 20)

Jeżeli któryś z elementów nie występuje w wynikowym punkcie adresowym, oznacza to, że został odrzucony podczas wyszukiwania.

Parametry

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

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:

  • miejscowość (city)
  • kod pocztowy (zip)
  • ulica (street)
  • numer (streetNumber)
  • obszary administracyjne adm1, adm2, amd3 (areaName1, areaName2, areaName3)
  • współrzędne geograficzne środka wyszukanego punktu oraz prostokąta otaczającego wyszukany obiekt, np. miejscowość, czy ulicę (middlePoint.longitude, middlePoint.latitude, topLeft.longitude, topLeft.latitude, bottomRight.longitude, bottomRight.latitude)
  • kod błędu (result: 0 = ok, 1 = brak wyników, 2 = zbyt dużo wyników, zwrócono pierwsze 20)

Jeżeli któryś z elementów nie występuje w wynikowym punkcie adresowym, oznacza to, że został odrzucony podczas wyszukiwania.

Parametry

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

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).

Parametry

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

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ą:

  • nazwę państwa i dwóch obszarów administracyjnych najwyższego poziomu (parametry areaName0, areaName1, areaName2)
  • kod pocztowy (zip)
  • miejscowość (city.name; city.foundLength to odległość w metrach od danego punktu)
  • nazwę ulicy lub drogi i ewentualne oznaczenie drogi międzynarodowej (street.name, road.name, internationalRoad.name; pola foundLength zawierają odległość w metrach znalezionego obiektu od danego punktu) Dodatkowo przekazywany jest kod błędu (result: 0 = ok, 1 = brak danych).

Parametry

points{Array(EMAPI.LonLat)} Punkty do zdegeokodowania.
zoom{Integer} Powiększenie degeokodowania informacji (wartość z zakresu 0-17).
callback{Function} Funkcja obsługi zwracanych danych.

getObjectCategories

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:

  • identyfikator kategorii (id)
  • nazwę kategorii (categoryName)
  • liczbę obiektów kategorii z podziałem na obiekty punktowe, liniowe i obszarowe (pointCount, lineCount, areaCount)
  • listę podkategorii zawierających identyfikator (id), nazwę (name), parametry wizualne obiektów (borderColor, borderOpacity, borderWidth, fillColor, fillOpacity, iconURL, height, width) i zakres powiększeń widoczności (zoomMin, zoomMax).

Parametry

callback{Function} Funkcja obsługi parametrów kategorii.

getPOICategories

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:

  • identyfikator kategorii (id)
  • nazwę kategorii (categoryName)
  • liczbę obiektów kategorii z podziałem na obiekty punktowe, liniowe i obszarowe (pointCount, lineCount, areaCount)
  • listę podkategorii zawierających identyfikator (id), nazwę (name), parametry wizualne obiektów (borderColor, borderOpacity, borderWidth, fillColor, fillOpacity, iconURL, height, width) i zakres powiększeń widoczności (zoomMin, zoomMax).

Parametry

callback{Function} Funkcja obsługi parametrów kategorii.

searchObjects

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:

  • identyfikator (id)
  • identyfikator podkategorii (subcategoryId)
  • miejscowość (city)
  • państwo (country)
  • kod pocztowy (zip)
  • ulica (street)
  • opis (description)
  • współrzędne geograficzne środka wyszukanego obiektu (lon, lat) (middlePoint.longitude, middlePoint.latitude, topLeft.longitude, topLeft.latitude, bottomRight.longitude, bottomRight.latitude)
  • kod błędu (result: 0 = ok, 1 = brak wyników, 2 = zbyt dużo wyników, zwrócono pierwsze 50)

Uwzględniane są wszystkie parametry przekazane do funkcji (koniunkcja warunków).

Parametry

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

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:

  • identyfikator (id)
  • identyfikator podkategorii (subcategoryId)
  • miejscowość (city)
  • państwo (country)
  • kod pocztowy (zip)
  • ulica (street)
  • opis (description)
  • współrzędne geograficzne środka wyszukanego obiektu (lon, lat) (middlePoint.longitude, middlePoint.latitude, topLeft.longitude, topLeft.latitude, bottomRight.longitude, bottomRight.latitude)
  • kod błędu (result: 0 = ok, 1 = brak wyników, 2 = zbyt dużo wyników, zwrócono pierwsze 50)

Uwzględniane są wszystkie parametry przekazane do funkcji (koniunkcja warunków).

Parametry

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.
destroy: function()
Niszczy obiekt klasy EMAPI.Finder.
setCountry: function(country)
Ustawia kontekst kraju, w którym następuje wyszukiwanie danych.
setLanguage: function (language)
Ustawia kontekst językowy dla wyników zwracanych przez funkcje search i geocode.
getCountry: function()
Zwraca kod ccTLD kraju aktualnie ustawionego dla wyszukiwania.
getLanguage: function ()
Zwraca kontekst językowy aktualnie ustawiony dla wyszukiwania.
search: function (address,
callback,
options)
Wyszukuje punkty adresowe zgodne z podanym adresem.
geocode: function (country,
city,
zip,
street,
streetnumber,
callback)
Wyszukuje punkty adresowe zgodne z podanymi danymi adresowymi.
getCoordinates: function(index,
callback)
Pobiera lokalizację na mapie jednego z punktów adresowych wyszukanych za pomocą funkcji search.
degeocode: function(points,
zoom,
callback)
Wyszukuje informacje geograficzne dla punktów o podanych współrzędnych.
getObjectCategories: function(callback)
Zwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów statycznych klienta.
getPOICategories: function(callback)
Zwraca w formie wywołania funkcji wszystkie parametry kategorii obiektów POI.
searchObjects: function(categoryNames,
searchText,
lonLat,
objectCount,
queryRadius,
objectIDs,
callback)
Wyszukuje obiekty statyczne klienta.
searchPOI: function(categoryNames,
searchText,
lonLat,
objectCount,
queryRadius,
objectIDs,
callback)
Wyszukuje obiekty POI.
Instancje klasy EMAPI.Map są interaktywnymi mapami osadzanymi w aplikacjach internetowych.
Klasa reprezentująca współrzędne geograficzne punktu w formie pary szerokości i długości geograficznej.
Close