WebOffice Script API - WebOffice flex |
  
|
WebOffice Script API - WebOffice flex |
|
Eine detaillierte Dokumentation der Funktionen und deren Parametern befindet sich in der Java Script Quelldatei, die im WebOffice 10.8 SP2 Applikationsverzeichnis zu finden ist: <Web Applikation>\client_flexjs\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 flex Client verwendet werden können.
Derzeit implementierte Funktionen für die WebOffice 10.8 SP2 Script API:
Karte, Kartenansichten und Layer
•scriptAPI.mapByCenterpointScale( fCenterX, fCenterY, iScale )
Abfrage einer neuen Karte über Mittelpunkt und Maßstab
Werkzeug Auswahl
•scriptAPI.getActiveTool()
Ruft das derzeit aktivierte Werkzeug auf
•scriptAPI.getActiveCustomTool()
Ruft das derzeit aktivierte Custom Tool auf
•scriptAPI.getCustomTool(sToolId)
Ruft ein Custom Tool auf
•scriptAPI.setTool() = function ( sToolId )
Aktiviert ein entsprechendes Werkzeug per Werkzeug ID (diese Funktion ist nur bei einigen Werkzeugen verfügbar: ToolSelect, ToolEdit, geoprocessing tools, custom Tools)
•client.api.closeActiveTool()
Schließt alle derzeitig aktivierten Werkzeuge (funktioniert auch bei einfachen und erweiterten Custom Tools)
GUI Operationen
•scriptAPI.addGUIModule( sName, sUrl, iState, sTitle, bCanBeClosed )
Fügt ein neues GUI Modul zum WebOffice 10.8 SP2 GUI hinzu
•scriptAPI.getGUIModule( argModule )
Ruft den WebOffice 10.8 SP2 GUI-Modul für eine verschachtelte iFrame auf.
•scriptAPI.getGUIModuleByName( argName )
Ruft den WebOffice 10.8 SP2 GUI-Modul über seinen Namen auf
•scriptAPI.removeGUIModule( module )
Entfernt das hinzugefügte GUI-Modul vom Namen-Modul
•scriptAPI.lockGUI: ( argOptions )
Sperrt das WebOffice 10.8 SP2 GUI-Modul; es sind keine Benutzer-Interaktionen mehr möglich, bis die Sperre wieder freigegeben ist
Attributive Suchen
•scriptAPI.queryAttributive( sQueryname, sKeyname, sKeyvalue )
Zeigt Ergebnis-Raster und selektiert Features auf der Karte; Karte wird durch Zoomen auf Ergebnis-Features aktualisiert
•scriptAPI.queryAttributiveMultiLayer( argQueries )
Zeigt Ergebnis-Raster und selektiert Features anhand von einem oder mehrerer Layer auf der Karte; Karte wird durch Zoomen auf Ergebnis-Features aktualisiert
•scriptAPI.featureZoomAttributive( sQueryname, sKeyname, sKeyvalue )
Kein Ergebnis-Raster; keine Feature-Selektion auf der Karte, Karte wird durch Zoomen auf Ergebnis-Features aktualisiert
•scriptAPI.featurePanAttributive( sQueryname, sKeyname, sKeyvalue )
Kein Ergebnis-Raster; keine Feature-Selektion auf der Karte; Karte wird durch Pannen auf Ergebnis-Features aktualisiert
•scriptAPI.locateFeaturesAttributive( sQueryname, sKeyname, sKeyvalue )
Kein Ergebnis-Raster, keine Feature-Selektion auf der Karte, keine Karten-Aktualisierung
•scriptAPI.displayResultAttributive( sQueryname, sKeyname, sKeyvalue )
Zeigt Ergebnis-Raster; keine Feature-Selektion auf der Karte; keine Karten-Aktualisierung
Fangen
•scriptAPI.getSnapProfiles( callbackfct )
Holt das konfigurierte Fangprofil
•scriptAPI.getSnap(sSnapProfileId, callbackfct)
Holt die Fang-Eckpunkte des aktuellen Kartenausschnittes und des übergebenen Fangprofils
Andere
•scriptAPI.userMessage( sMessage, bAlert, bIsNote )
Zeigt eine Benachrichtigung des Benutzers
•scriptAPI.Env()
Erwidert ein Javascript Objekt, das grundlegende Eigenschaften der WebOffice 10.8 SP2 Umgebung enthält
•scriptAPI.mapInfo()
Erwidert Basis-Informationen über die Karte
•scriptAPI.log( sLogMessage )
Anmelden im clientseitigen WebOffice 10.8 SP2 Logmonitor
•scriptAPI.mapByCenterpointScale: ( fCenterX, fCenterY, iScale )
Abfrage einer neuen Karte über Mittelpunkt und Maßstab