JsDoc: Joms.App

Joms.App(elname, cfg)

Základní objekt API zastřešující celou mapovou aplikaci. Vytváří mapu do definováné elementu a určuje celkové chování aplikace.

parametry

String	elname	Id elementu, kde má být mapa zobrazena. Id elementu nesmí obsahovat podtržítko (znak "_").
Joms.AppConf	cfg?	Konfigurační objekt aplikace.

metody

init(map, zoom, startPos, base)

initRect(rect, baseMap)

getMapId(mapId)

setMapSize(width, height)

addStaticElement(el)

removeStaticElement(el)

setZoomInfo(inf)

getAvailableZoomInfoArray()

changeMap(map, zoom)

changeMapAndPreservePosition(map)

setBounds(map, ld, ru)

removeBounds(map)

getImageUrl(width, height)

vlastnosti

Joms.Map map Ukazatel na mapový objekt.

Joms.Hooks hooks Ukazatel na objekt pro modifikaci aplikace při speciálních událostech.

Joms.TextBox textBox Ukazatel na objekt pro zobrazení bubliny v mapě.

Joms.App.init(map, zoom, startPos, base)

Inicializace (úvodní zobrazení) mapové aplikace. Vytvoří všechny potřebné objekty pro zobrazení mapy.

parametry

String	map	Textové id mapy k zobrazení (nepovinné).
int	zoom?	Úvodní stupeň přiblížení mapy. Mapa s největším měřítkem má zoom 0 (nepovinné).
Joms.Coord	startPos?	Pozice středu mapy. Pokud není zadáno, je použit automaticky střed mapy (nepovinné).
string	base?	Textové id základní mapy (nepovinné).

Joms.App.initRect(rect, baseMap)

Inicializace (úvodní zobrazení) mapové aplikace. Vytvoří všechny potřebné objekty pro zobrazení mapy. Mapa je inicializována tak, aby souřadnicový obdélník rect byl v mapě celý viditelný.

parametry

Joms.Rect	rect?	Oblast, na kterou má být přiblíženo.
string	baseMap?	Textové id základní mapy (není povinné).

Joms.App.getMapId(mapId)

Zjistí, zda mapId je platným ID mapy. Pokud je číselné, pak vrátí textové id odpovídající mapy.

parametry

mapId

Joms.App.setMapSize(width, height)

Změní velikost elementu s mapou.

parametry

int	width	Nová šířka mapy.
int	height	Nová výška mapy.

Joms.App.addStaticElement(el)

Přidá element do okna s mapou. Element musí být absolutně poziciován a měl by mít z-index větší jak 1000, aby byl viditelný nad ostatními prvky mapy.

parametry

el

Joms.App.removeStaticElement(el)

Odstraní element z okna s mapou.

parametry

el

Joms.App.setZoomInfo(inf)

Nastaví zoom na hodnoty objektu získaného metodou getAvailableZoomInfoArray

parametry

inf

Joms.App.getAvailableZoomInfoArray()

Vrátí pole s informacemi o dostupných zoomech nad konkrétní pozicí. Každý prvek pole je objekt s parametry:

map - id mapy
zoom - id zoomu v rámci dané mapy
selectd - příznak, zda je daný zoom aktivní

Objekt lze posléze použít pro nastavení zoomu metodou setZoomInfo.

Joms.App.changeMap(map, zoom)

Změní zobrazenou mapu v aplikaci.

parametry

String	map	Textový název nové mapy.
int	zoom?	Číslo zoomu (přiblížení) mapy.

Joms.App.changeMapAndPreservePosition(map)

Změní zobrazenou mapu v aplikaci. Při změně se snaží zachovat aktuálně zobrazenou pozici v mapě.

parametry

String

map

Textový název nové mapy.

Joms.App.setBounds(map, ld, ru)

Nastaví pevnou hranici pro danou mapu. Zobrazení této mapy bude dovoleno pouze v zadaném výřezu.

parametry

String	map	Textový název mapy.
Joms.Coord	ld	Levý spodní roh výřezu.
Joms.Coord	ru	Pravý horní roh výřezu.

Joms.App.removeBounds(map)

Odstraní hranici z dané mapy. Hranice musela být předtím definována funkcí setBounds.

parametry

map

Joms.App.getImageUrl(width, height)

Vrací URL statického obrázku s mapou. Toto URL je pak možné vložit do src image elementu a získat tak obrázek pro tisk.

parametry

int	width	šířka obrázku v pixelech
int	height	výška obrázku v pixelech