Masarykova univerzita

- popis rozhraní

Upozornění Toto je starší verze (1.6.0) munimapu. Doporučujeme použít nejnovější verzi.

Upozornění Knihovna munimap využívá službu Google Analytics, poskytovanou společností Google. Pro použítí knihovny je třeba na Vašich stránkách přidat upozornění pro uživatele, že stránky využívají soubory cookies. Cookies upozornění můžete přidat pomocí skriptu, který naleznete například zde.

Pro formální popis rozhraní používáme javascriptovou anotaci pro Closure Compiler.

Funkce munimap.create

Vytvoří mapu do zadaného elementu a vykreslí ji dle zadaných parametrů.

Specifikace

munimap.create(options: Object): goog.Promise<ol.Map>

Vstup

Objekt definující požadované vlastnosti vytvářené mapy pomocí těchto parametrů:

Název parametru Typ Popis
target string | Element
  • id elementu nebo element, do kterého se vloží mapové okno
  • parametr je povinný
markers Array.<string> | Array.<ol.Feature> | undefined
  • pole textových řetězců může být
    • pole polohových kódů budov,
    • pole polohových kódů místností,
    • pole polohových kódů dveří nebo
    • pole kategorií bodů zájmu (od verze 1.4)
  • v případě polohových kódů je možné využít zástupného znaku '_'
  • kategorie bodů zájmu mohou být
    • poi.ctg:print-center (tisková centra)
    • poi.ctg:credit-top-up-machine (bankovníky)
    • poi.ctg:retail-location (prodejní místa)
  • od verze 1.1 je možné umístit "špendlík" na libovolné místo v mapě, a to pomocí pole objektů typu ol.Feature s parametry:
    • geometry definující geometrii pomocí objektu ol.geom.Point
    • label pro textový popisek bodu
  • není-li parametr zadán, nic se v mapě nezvýrazní

pro zjištění polohových kódů budov, místností či dveří lze použít aplikaci Kompas

markerLabel function((ol.Feature | ol.render.Feature), number): (string | null | undefined) | undefined
  • funkce pro úpravu textu popisků zvýrazněných budov či místností
  • první parametr je objekt, pro který funkce vrací popisek, druhý parametr je rozlišení mapy (resolution); aplikace tedy může ukazovat různé popisky jednoho objektu pro různé úrovně přiblížení
  • není-li funkce zadána, zobrazí se stejný text popisku jako v případě, kdy budova či místnost nejsou označeny

pro rozlišení jednotlivých zvýrazněných budov či místností lze využít jejich polohový kód, který ve funkci získáte pomocí feature.get('polohKod')

experimentální funkcionalita

zoomTo Array.<string> | string | undefined
  • pole polohových kódů budov, nebo polohových kódů místností, na které se má mapa zazoomovat
  • v polohových kódech je možné využít zástupného znaku '_'
  • není-li parametr zadán a současně je zadán parametr markers, převezme hodnotu tohoto parametru
  • není povoleno použítí parametru zároveň s parametrem center

pro zjištění polohových kódů budov či místností lze použít aplikaci Kompas

zoom number | undefined
  • výchozí zoom mapy
  • není-li parametr zadán, je dopočítán podle zoomTo, případně se zobrazí celé Brno
  • je akceptováno celé kladné číslo v rozsahu 0 až 23, kdy 0 je pohled na celý svět a 23 je největší povolený zoom

zoom 13 odpovídá pohledu na celé Brno

center ol.Coordinate | undefined
  • výchozí střed mapy v zeměpisné šířce a délce (EPSG:4326)
  • není-li parametr zadán, je dopočítán podle zoomTo, případně se zobrazí celé Brno
  • není povoleno použítí parametru zároveň s parametrem zoomTo
lang string | undefined
  • jazyk
  • možné hodnoty jsou 'cs' a 'en'
  • výchozí nastavení je 'cs'
baseMap string | undefined
  • podkladová mapa
  • možné hodnoty jsou 'osm' pro barevnou OpenStreetMapu a 'osm-bw' pro její černobílou verzi
  • výchozí nastavení je 'osm-bw'

v prohlížečích Internet Explorer (mimo Edge) je podkladová mapa zobrazena vždy barevně nezávisle na hodnotě parametru baseMap

pubTran boolean | undefined
  • zastávky brněnské MHD s info bublinou
  • možné hodnoty jsou true pro zobrazení zastávek a false pro skrytí
  • výchozí nastavení je false
  • informace o umístění zastávek MHD poskytuje firma KORDIS JMK, a.s.

Výstup

goog.Promise<ol.Map>

Funkce munimap.reset

Přenastaví zadané parametry mapy na nové hodnoty, ostatní parametry nastaví na výchozí hodnoty.

Specifikace

munimap.reset(map: ol.Map, options: Object): goog.Promise<ol.Map>

Vstup

Již existující mapa vytvořená pomocí funkce munimap.create a objekt s parametry, které mají být přenastaveny. Oproti funkci munimap.create nejsou potřeba parametry target a lang, jelikož ty jsou definovány pro původní mapu.

Název parametru Typ Popis
markers Array.<string> | Array.<ol.Feature> | undefined
  • pole polohových kódů budov, nebo polohových kódů místností, nebo polohových kódů dveří, které mají být v mapě zvýrazněny
    • v polohových kódech je možné využít zástupného znaku '_'
  • od verze 1.1 je možné umístit "špendlík" na libovolné místo v mapě, a to pomocí pole objektů typu ol.Feature s parametry:
    • geometry definující geometrii pomocí objektu ol.geom.Point
    • label pro textový popisek bodu
  • není-li parametr zadán, nic se v mapě nezvýrazní

pro zjištění polohových kódů budov, místností či dveří lze použít aplikaci Kompas

markerLabel function((ol.Feature | ol.render.Feature), number): (string | null | undefined) | undefined
  • funkce pro pro úpravu textu popisků zvýrazněných budov či místností
  • první parametr je objekt, pro který funkce vrací popisek, druhý parametr je rozlišení mapy (resolution); aplikace tedy může ukazovat různé popisky jednoho objektu pro různé úrovně přiblížení
  • není-li funkce zadána, zobrazí se stejný text popisku jako v případě, kdy budova či místnost nejsou označeny

pro rozlišení jednotlivých zvýrazněných budov či místností lze využít jejich polohový kód, který ve funkci získáte pomocí feature.get('polohKod')

experimentální funkcionalita

zoomTo Array.<string> | string | undefined
  • pole polohových kódů budov, nebo polohových kódů místností, na které se má mapa zazoomovat
  • v polohových kódech je možné využít zástupného znaku '_'
  • není-li parametr zadán a současně je zadán parametr markers, převezme hodnotu tohoto parametru
  • není povoleno použítí parametru zároveň s parametrem center

pro zjištění polohových kódů budov či místností lze použít aplikaci Kompas

zoom number | undefined
  • výchozí zoom mapy
  • není-li zadán, je dopočítán podle zoomTo, případně se zobrazí celé Brno
  • je akceptováno celé kladné číslo v rozsahu 0 až 23, kdy 0 je pohled na celý svět a 23 je největší povolený zoom
center ol.Coordinate | undefined
  • výchozí střed mapy v zeměpisné šířce a délce (EPSG:4326)
  • není-li zadán, je dopočítán podle zoomTo, případně se zobrazí celé Brno
  • není povoleno použítí parametru zároveň s parametrem zoomTo

Výstup

goog.Promise<ol.Map>