EMAPI.Map

Instancje klasy EMAPI.Map są interaktywnymi mapami osadzanymi w aplikacjach internetowych. Nowa mapa tworzona jest za pomocą konstruktora EMAPI.Map. Wyszukiwanie danych na mapie jest realizowane za pomocą instancji klasy EMAPI.Finder.

Dodatkowe warstwy obiektów nakłada się na mapę za pomocą instancji klasy EMAPI.VectorLayer.

Podsumowanie

EMAPI.Map	Instancje klasy EMAPI.Map są interaktywnymi mapami osadzanymi w aplikacjach internetowych.
Pola
categoryObjects	{EMAPI.CategoryObjects} Obiekt umożliwiający zarządzanie obiektami statycznymi pojawiającymi się na mapach (dotyczy to obiektów POI oraz dodatkowych obiektów klienta ładowanych automatycznie).
Konstruktory
EMAPI.Map	Konstruktor nowej instancji mapy klasy EMAPI.Map.
Funkcje
destroy	Niszczy obiekt mapy.
addMapAction	Dodaje nową akcję do menu konteksowego mapy.
removeMapAction	Usuwa akcję z menu konteksowego mapy.
setInfoCallback	Przypisuje funkcję wywoływaną przy każdym użyciu akcji informacyjnej na mapie.
convertLonLatToScreen	Konwertuje współrzędne geograficzne na ekranowe punktu z aktualnego widoku mapy.
convertScreenToLonLat	Konwertuje współrzędne ekranowe na geograficzne punktu z aktualnego widoku mapy.
getBounds	Zwraca współrzędne geograficzne prostokąta aktualnego widoku mapy.
setBounds	Dostosowuje aktualny widok mapy do zaprezentowania prostokąta o podanych współrzędnych geograficznych.
setCenterPos	Centruje aktualny widok mapy względem punktu o podanych współrzędnych geograficznych.
getCenterPos	Zwraca współrzędne geograficzne punktu środkowego aktualnego widoku mapy.
loadTrack	Wymusza załadowanie z serwera obiektu dynamicznego o podanym identyfikatorze.
removeTracks	Usuwa z mapy wszystkie wcześniej załadowane obiekty dynamiczne.

Pola

categoryObjects

{EMAPI.CategoryObjects} Obiekt umożliwiający zarządzanie obiektami statycznymi pojawiającymi się na mapach (dotyczy to obiektów POI oraz dodatkowych obiektów klienta ładowanych automatycznie).

Konstruktory

EMAPI.Map

Konstruktor nowej instancji mapy klasy EMAPI.Map.

Parametry

div	{String} Identyfikator elementu na stronie, który ma zawierać mapę.
userID	{String} Identyfikator użytkownika.
options	{Object} Dodatkowe parametry mapy.

Funkcje

destroy

Niszczy obiekt mapy.

addMapAction

Dodaje nową akcję do menu konteksowego mapy.

Parametry

menuPosition	{Integer} Pozycja w menu kontekstowym, na której ma pojawić się nowa akcja (wartość >= 0).
caption	{String} Tytuł akcji.
icon	{String} URL ikony dla akcji.
callback	{Function} Funkcja uruchamiana po wybraniu akcji z menu kontekstowego.

removeMapAction

Usuwa akcję z menu konteksowego mapy.

Parametry

menuPosition

{Integer} Pozycja w menu kontekstowym, na której znajduje się przeznaczona do usunięcia akcja (wartość >= 0).

setInfoCallback

Przypisuje funkcję wywoływaną przy każdym użyciu akcji informacyjnej na mapie. Dane przekazywane do podstawianej funkcji zawierają:

nazwę państwa i obszaru administracyjnego najwyższego poziomu (parametry position.areaName0 i position.areaName1)
kod pocztowy (position.zip)
listę najbliższych miejscowości (position.cities - może być pusta)
nazwę oraz typ ulicy lub drogi i ewentualne oznaczenie drogi międzynarodowej (position.street, position.road, position.internationalRoad - jeżeli odnaleziono w danym miejscu) - typ (position.typeIndex) jest wartością z zakresu 0-7 oznaczojącą odpowiednio autostradę, drogę ekspresową, drogę krajową, drogę wojewódzką, drogę lokalną, ulicę główną, ulicę zwykłą lub prom
nazwę budynku, placu lub przejścia granicznego (position.building, position.square, position.borderCrossing - o ile znaleziono taki obiekt)
nazwy najbliższych obiektów nakładanych na mapę w formie dodatkowych warstw (parametr objects typu {Array(EMAPI.Object)} - o ile znaleziono takie obiekty)
współrzędne geograficzne wskazanego przez użytkownika punktu (position.lon, position.lat)
kod błędu (position.result: 0 = ok, 1 = brak danych)

Parametry

callback

{Function} Funkcja dodatkowej obsługi akcji informacyjnej.

convertLonLatToScreen

Konwertuje współrzędne geograficzne na ekranowe punktu z aktualnego widoku mapy.

Parametry

lonLat

{EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne geograficzne punktu.

Wynik

{EMAPI.Pixel} Obiekt typu EMAPI.Pixel reprezentujący współrzędne ekranowe punktu.

convertScreenToLonLat

Konwertuje współrzędne ekranowe na geograficzne punktu z aktualnego widoku mapy.

Parametry

px	{EMAPI.Pixel} Obiekt typu EMAPI.Pixel reprezentujący współrzędne ekranowe punktu.

Wynik

{EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne geograficzne punktu.

getBounds

Zwraca współrzędne geograficzne prostokąta aktualnego widoku mapy.

Wynik

{EMAPI.Bounds} Obiekt typu EMAPI.Bounds reprezentujący zakres mapy.

setBounds

Dostosowuje aktualny widok mapy do zaprezentowania prostokąta o podanych współrzędnych geograficznych.

Parametry

bounds

{EMAPI.Bounds} Obiekt typu EMAPI.Bounds reprezentujący żądany obszar mapy.

setCenterPos

Centruje aktualny widok mapy względem punktu o podanych współrzędnych geograficznych.

Parametry

lonLat	{EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne geograficzne żądanego punktu.
zoom	{Integer} Żądane powiększenie (wartość z zakresu 0-17).

getCenterPos

Zwraca współrzędne geograficzne punktu środkowego aktualnego widoku mapy.

Wynik

{EMAPI.LonLat} Obiekt typu EMAPI.LonLat reprezentujący współrzędne zwracanego punktu.

loadTrack

Wymusza załadowanie z serwera obiektu dynamicznego o podanym identyfikatorze.

Parametry

token	{String} Unikalny identyfikator obiektu (token).
format	{String} Format zapisu danych obiektu (NMEA lub CSV). W przypadku formatu CSV konieczne są przynajmniej dwa pola o nazwach Longitude i Latitude.
description	{String} Opis obiektu pojawiający się w oknie informacyjnym.
color	{String} Heksadecymalny kolor obiektu (np. #00ff00).
reload	{Boolean} Informacja czy dane obiektu mają być załadowane ponownie z serwera, czy z cache’u serwera EMAPI.
showInfo	{Boolean} Informacja czy wyświetlać okno informacyjne nad obiektem.
infoDistance	{Float} Odległość w km pomiędzy automatycznie generowanymi punktami charakterystycznymi obiektu, nad którymi będzie dostępna funkcjonalność okna informacyjnego (dotyczy obiektów ścieżkowych). Wartość 0 oznacza generowanie punktu informacyjnego w każdym punkcie obiektu. Istotne gdy włączana jest opcja showInfo.
iconURL	{String} URL ikony obiektu.
iconWidth	{Integer} Szerokość ikony.
iconHeight	{Integer} Wysokość ikony.

removeTracks

Usuwa z mapy wszystkie wcześniej załadowane obiekty dynamiczne.