WebOffice Script API - WebOffice core |
  
|
WebOffice Script API - WebOffice core |
|
Eine detaillierte Dokumentation der Funktionen und deren Parametern befindet sich in der Java Script Quelldatei, die im WebOffice 10.7 SP1 Applikationsverzeichnis zu finden ist: <Web Applikation>\client_core\js\api
Hinweis: Die Datei ScriptApi.js enthält fast die gleiche Funktionalität wie aus dem WebOffice html Client. Die anderen js-Dateien enthalten zusätzliche Funktionen, die im WebOffice core Client verwendet werden können.
•client.api.showRibbon (argRibbonIdxOrId);
Zeigt ein Ribbon durch Aufruf des Index oder der externen Kennung. Der Parameter argRibbonIdxOrId ist die externe ID einer Multifunktionsleiste und beginnt dabei bei 0.
•client.api.closeActiveTool();
Schließt das aktuell aktivierte Tool in der Multifunktionsleiste (funktioniert ebenfalls mit einfachen und erweiterten Custom Tools).
Hinweis: Diese Funktion funktioniert nicht mit Static Custom Tools oder One-Click Werkzeugen
•api.addApiMarkup(argMarkupObject);
Fügt ein neues Markup-Objekt (Point, Polyline, Polygon, Circle oder Text) im WebOffice core Client hinzu. Der Parameter argMarkupObject ist ein verpflichtendes JSON-Objekt, das die Zeichnung beschreibt.
•api.hasApiMarkup(argMarkupId);
Überprüft, ob das Markup in der Karte dargestellt wird. Der Parameter argMarkupObject repräsentiert die ID der Zeichnung, deren Darstellung in der Karte überprüft werden soll.
•api.getApiMarkupIds();
Fragt alle Markup-Objekte ab, die über die API erstellt wurden.
•api.deleteApiMarkupById(argMarkupIds);
Löscht alle Markup-Objekte auf Basis der angegebenen IDs. Der Parameter argMarkupIds spiegelt die zu löschenden IDs in Form eines Texts oder einer Liste wider. Wenn der Wert dieses Parameters NULL ist, werden alle Zeichnungen gelöscht, die mithilfe der API erstellt wurden.
Hinweis: Um die vier oben genannten Funktionen verwenden zu können, muss das Werkzeug Zeichnen im WebOffice 10.7 SP1 Projekt ankonfiguriert und für den entsprechenden User im WebOffice usermanagement freigeschalten sein. Weitere Informationen zur Konfiguration des Werkzeuges Zeichnen finden Sie im Kapitel Zeichnen.
Hinweis: Eine detaillierte Dokumentation der vier oben genannten Funktionen inkl. entsprechender Anwendungsbeispiele befindet sich in folgender Datei: <Web Applikation>\client_core\js\api\readme.txt
•client.api.addGeoNode();
Fügt sogenannte GeoNodes der Karte hinzu.