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.
Pola
country{String} Kod kraju, w którym wyszukiwane są dane zgodny ze standardem ccTLD.
Konstruktory
EMAPI.FinderKonstruktor nowej instancji klasy EMAPI.Finder.
Funkcje
destroyNiszczy obiekt klasy EMAPI.Finder.
setCountryUstawia kontekst kraju, w którym następuje wyszukiwanie danych.
getCountryZwraca kod ccTLD kraju aktualnie ustawionego dla wyszukiwania.
searchWyszukuje punkty adresowe zgodne z podanym adresem.
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.

Pola

country

{String} Kod kraju, w którym wyszukiwane są dane zgodny ze standardem ccTLD.  Domyślnie ustawiany zgodnie z kodem domeny najwyższego poziomu dla domeny, w której uruchamiany jest skrypt.

Konstruktory

EMAPI.Finder

Konstruktor nowej instancji klasy EMAPI.Finder.

Parametry

map{EMAPI.Map} Obiekt klasy EMAPI.Map reprezentujący mapę, która ma być przeszukiwana.
options{Object} Obiekt z dodatkowymi parametrami instancji klasy.

Funkcje

destroy

Niszczy obiekt klasy EMAPI.Finder.

setCountry

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

Parametry

country{String} Kod ccTLD żądanego kraju.

getCountry

Zwraca kod ccTLD kraju aktualnie ustawionego dla wyszukiwania.

Wynik

{String} Kod ccTLD kraju.

search

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 (areaName0, areaName1, areaName2)
  • 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 50) Współrzędne geograficzne są zwracane tylko dla pierwszego elementu z listy wyników.  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 poiomu) oddzielonych przecinkami.  Wielkość liter nie ma znaczenia.
callback{Function} Funkcja obsługi wyników wyszukiwania.

getCoordinates

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

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.
Wyszukuje punkty adresowe zgodne z podanym adresem.
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