Požadavky

Před samotným začátkem práce s API se ujistěte, že jste obdrželi klíč potřebný k vložení externího scriptu.

Dále budete potřebovat soubor apiClient.php, který umístěte na Váš webserver. Tento soubor bude volaný mapovou aplikací. Cestu k němu lze nastavit globální konfigurační direktivou:

Joms.dataScript = '/cesta/k/apiClient.php';
Important Kvůli zabezpečení webových prohlížečů musí být soubor apiClient.php dostupný ve stejné doméně, v které se nachází mapová aplikace.

Vložení API na stránky

Script se nachází na níže uvedené adrese a očekává uvedené parametry:

http://api.planstudio.cz/?lang=<1>&v=<2>&id=<3>

  1. Jazyková mutace, v současné době pouze cze.

  2. Verze API, pokud začínate, použijte verzi 4.

  3. Klíč, který Vám byl přidělen.

Příklad vložení scriptu v jazyce JavaScript
<script type="text/javascript" src="http://api.planstudio.cz/?lang=cze&amp;v=4&amp;id=abcdefgh12345"></script>
Note Váš klíč se váže k doménám, pro které byl povolen firmou PLANstudio. Využití na jiných doménách je v rozporu s licenčními podmínkami.

Pro úspěšně zobrazení mapy musíte vložit i kaskádový styl pomocí:

<link rel="stylesheet" href="http://api.planstudio.cz/misc/style/api.css" type="text/css" media="screen" />

Veškeré styly začínají prefixem .joms a můžete si je upravit dle potřeby.

Inicializace aplikace

Pro inicializaci jednoduché aplikace stačí vytvořit objekt Joms.App s patřičnými parametry.

Na příkladu je ukázáno vytvoření nejzákladnější aplikace do HTML elementu:

<div id="divElement"></div>
Příklad vytvoření jednoduché aplikace
<script type="text/javascript">
var width = 500;
var height = 400;

var myApp = new Joms.App('divElement', new Joms.AppConf(), width, height);
myApp.init('cesko');
</script>
Important Element, do kterého je mapová aplikace vytvořena, musí být pozicován relativně nebo absolutně (např. style="position: relative"). V jiných případech bude mapa špatně vykreslena. ID elementu nesmí obsahovat znak podtržítko ("_").