WebOffice Script API |
  
|
WebOffice Script API |
|
Die WebOffice 10.2 SP3 Script API ermöglicht es Entwicklern, spezielle WebOffice 10.2 SP3 Funktionen über JavaScript Methodenaufrufe zu kontrollieren. Eine integrierte Hilfe für das dynamische Laden der Script API ist verfügbar. Verwenden Sie die Methode client.loadScriptAPI(), um explizit die WebOffice 10.2 SP3 Script API zu laden.
Bevor Sie die Methoden der Script API verwenden, sollten die folgenden Codelines in der Komponente mit der WebOffice 10.2 SP3 Script API ausgeführt werden:
if( !parent.scriptAPI ){
parent.client.loadScriptAPI();
}
Anschließend ist die Script API über das Objekt parent.scriptAPI verfügbar.
Voraussetzungen sind, dass das "parent" WebOffice 10.2 SP3 ist und dass der Skript-Zugriff zum "parent" gewährleistet ist.
Hinweis: Eine detaillierte Dokumentation befindet sich in der Java Script Quelldatei, die im WebOffice 10.2 SP3 Applikationsverzeichnis zu finden ist: <Web Applikation>\client_workspace\JSXAPPS\weboffice\js\scriptAPI.js oder in <Web Applikation>\pub\custom_tools\scriptAPI.txt.
Derzeit implementierte Funktionen für die WebOffice 10.2 SP3 Script API:
Karte, Kartenansichten und Layer
| • | scriptAPI.mapByCenterpointScale( fCenterX, fCenterY, iScale ) Abfrage einer neuen Karte über Mittelpunkt und Maßstab |
| • | scriptAPI.mapByExtent( fMinX, fMinY, fMaxX, fMaxY ) Abfrage einer neuen Karte über Extent-Werte |
| • | scriptAPI.setMapView (sViewId ) Wechsel zu einer vordefinierten Kartenansicht |
| • | scriptAPI.getMapLayers( sIdType, callbackFct ) Ruft die Layer der derzeit sichtbaren Client Karte und die Layersichtbarkeit ab |
| • | scriptAPI.setTocNodeVisibility( sNodeId, bVisible ) Legt die Sichtbarkeit eines TOC Knotens (Kartenservice, Gruppenlayer, Layer) fest |
| • | scriptAPI.getActiveRepmodel() Holt Informationen zum aktiven repmodel |
Werkzeug Auswahl
| • | scriptAPI.getActiveTool() Ruft das derzeit aktivierte Werkzeug auf |
| • | scriptAPI.getActiveCustomTool() Ruft das derzeit aktivierte Generische Werkzeug auf |
| • | scriptAPI.getCustomTool(sToolId) Ruft ein Generisches Werkzeug auf |
aktiviert ein entsprechendes Werkzeug per Werkzeug ID (diese Funktion ist nur bei einigen Werkzeugen verfügbar: ToolSelect, ToolEdit, geoprocessing tools, custom Tools)
GUI Operationen
| • | scriptAPI.addGUIModule( sName, sUrl, iState, sTitle, bCanBeClosed, iWidth, iHeight, sHtmlDivId, unload_callback, bCanBeDocked ) Fügt ein neues GUI Modul zum WebOffice 10.2 SP3 GUI hinzu |
| • | scriptAPI.getGUIModule( oWindow ) Ruft den WebOffice 10.2 SP3 GUI-Modul für eine verschachtelte iFrame auf. |
| • | scriptAPI.getGUIModuleByName(sGUIModuleName) Ruft den WebOffice 10.2 SP3 GUI-Modul über seinen Namen auf |
| • | scriptAPI.unhideGUIModule( oWindow ) Bringt ein GUI-Modul in die Benutzersicht, unabhängig vom Typ und derzeitigen Status des GUI-Moduls |
| • | scriptAPI.removeGUIModule( module ) Entfernt das hinzugefügte GUI-Modul vom Namen-Modul |
| • | scriptAPI.setDockingState( iState ) or scriptAPI.setToolFormDockingState( iState ) Setzt den Zustand des Werkzeugfensters auf abgedockt/angedockt |
| • | scriptAPI.setGUIModuleDockingStateByName( sGUIModuleName, iState ) Setzt den Zustand von einem GUI-Modul auf abgedockt/angedockt |
| • | scriptAPI.setGUIModuleDockingStateByIFrame( oIFrame, iState ) Setzt den Zustand von einen GUI-Modul auf abgedockt/angedockt |
| • | scriptAPI.setGUIModuleStateByIFrame( oIFrame, sState ) Setzt den Status von einem GUI-Modul vom Typ Floating auf minimalisiert/maximiert |
| • | scriptAPI.setToolFormSize( iWidth, iHeight ) Legt die Größe des Werkzeugfensters fest, sofern es im schwebenden Zustand ist und nicht an einem Quadranten des WebOffice 10.2 SP3 GUIs angedockt ist |
| • | scriptAPI.setGUIModuleSizeByName( sGUIModuleName, iWidth, iHeight ) Legt die Größe von einem GUI-Modul über Namen fest, sofern es im schwebenden Zustand ist und nicht an einem Quadranten des WebOffice 10.2 SP3 GUIs angedockt ist |
| • | scriptAPI.setGUIModuleSizeByIFrame( oIFrame, iWidth, iHeight ) Übergibt die Größe des GUI-Moduls zusammen mit dem iFrame Objekt, ob es freischwebend und nicht an einem Quadranten des WebOffice 10.2 SP3 GUIs angedockt ist |
| • | scriptAPI.snapToolFormToMap( bTop, bRight, bBottom, bLeft ) Fängt das Werkzeugfenster zur Kartengröße |
| • | scriptAPI.snapGUIModuleToMapByIFrame( oIFrame, bTop, bRight, bBottom, bLeft ) Fängt jedes WebOffice 10.2 SP3 GUI-Modul zur Kartengröße |
| • | scriptAPI.lockGUI( bLockGUI, sInfoText, sImagePath, iWidth, iHeight ) Sperrt das WebOffice 10.2 SP3 GUI-Modul; es sind keine Benutzer-Interaktionen mehr möglich, bis die Sperre wieder freigegeben ist |
| • | scriptAPI.printByCenterpointScale( fCenterX, fCenterY, iScale, sPrintTemplateId, sPrintFormat, bHighResolution, fPrintRotation, oDynFields, sDocumentName, bNoDocumentDisplay, sRepmodelId, aMultiPrintIdx, iPageOverlap ) Druckt eine Karte über den Mittelpunkt und Maßstab |
| • | scriptAPI.printByExtent( fMinX, fMinY, fMaxX, fMaxY, sPrintTemplateId, sPrintFormat, bHighResolution, fPrintRotation, oDynFields, sDocumentName, bNoDocumentDisplay, sRepmodelId ) Druckt eine Karte über Extent |
Hinweis: Siehe Druckausgabe Archivieren? für weitere Informationen über die Konfiguration im WebOffice author.
Attributive Suchen
| • | scriptAPI.queryAttributive( sQueryname, sKeyname, sKeyvalue, iMode ) Zeigt Ergebnis-Raster und selektiert Features auf der Karte; Karte wird durch Zoomen auf Ergebnis-Features aktualisiert |
| • | scriptAPI.zoomToAttributive( sQueryname, sKeyname, sKeyvalue ) Kein Ergebnis-Raster; zeigt selektierte Features 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.displayResultAttributive( sQueryname, sKeyname, sKeyvalue ) Zeigt Ergebnis-Raster; keine Feature-Selektion auf der Karte; keine Karten-Aktualisierung |
| • | scriptAPI.locateFeaturesAttributive( sQueryname, sKeyname, sKeyvalue ) Kein Ergebnis-Raster, keine Feature-Selektion auf der Karte, keine Karten-Aktualisierung |
| • | scriptAPI.queryAttributiveInternal( sQueryname, sKeyname, sKeyvalue ) Keine Ergebnis-Anzeige, keine Karten-Aktualisierung; die Features werden intern selektiert, so dass auf die nächste Karten Abfrage die Selektion auf der Karte angezeigt wird |
| • | scriptAPI.selectAttributive( sQueryname, sKeyname, sKeyvalue ) Keine Ergebnis Raster Anzeige, aktualisiert die Karte mit aktuellen Extent |
| • | scriptAPI.clearSelection( bMapSelectionOnly ) Löscht aktuelle Selektion |
| • | scriptAPI.zoomToSelected( objectIds ) Zoomen auf selektierte Features |
| • | scriptAPI.panToSelected( objectIds ) Pannen auf selektierte Features |
Filter
| • | scriptAPI.filterAttributive( sExtCallLayerId, aKeyname, aKeyvalue ) Führt einen attributiven Filter aus |
| • | scriptAPI.resetFilterAttributive( sExtCallLayerId ) Zurücksetzen des attributiven Filters |
Fangen
| • | scriptAPI.getSnapProfiles( callbackfct ) Holt das konfigurierte Fangprofil |
| • | scriptAPI.getSnap(sSnapProfileId, callbackfct) Holt die Fang-Eckpunkte des aktuellen Kartenausschnittes und des übergebenen Fangprofils |
WebOffice ePaper
| • | scriptAPI.generateEPaper( aObjectIds, sEPaperId, sEPaperFormat, sEPaperName, oDynFields, iDpiCount, bSuppressCopyright, bNoDocumentDisplay) Erstellt einen WebOffice ePaper Bericht für einen einzelnen Feature oder einem Feature-Set |
Hinweis: Für detaillierte Informationen über Möglichkeiten und Einschränkungen beim Erstellen von WebOffice ePaper Berichte mit Hilfe von WebOffice 10.2 SP3 Script API, siehe Kapitel Erstellen eines WebOffice ePaper Berichtes mittels Script API.
Andere
| • | scriptAPI.userMessage( sMessage, bAlert, bIsNote ) Zeigt eine Benachrichtigung des Benutzers |
| • | scriptAPI.Env() Erwidert ein Javascript Objekt, das gundlegende Eigenschaften der WebOffice 10.2 SP3 Umgebung enthält |
| • | scriptAPI.log( sLogMessage ) Anmelden im clientseitigen WebOffice 10.2 SP3 Logmonitor |
| • | scriptAPI.mapInfo() Erwidert Basis-Informationen über die Karte |
| • | scriptAPI.setScriptHookin( sEventId, oMethod ) Registriert eine Javascript Methode im clientseitigen Script |
Generische Zeichnen-Werkzeuge bieten eine Schnittstelle zum clientseitigem Zeichnen. Werkzeuge von diesem Typ haben einige Methoden, die wie folgt beschrieben sind:
| • | customtool.draw.setContentHeight( iHeight ); Legt die Höhe des Inhaltes vom generischen Werkzeug fest |
| • | customtool.draw.setSubmitCallback( callback ); Legt eine Javascript Funktion fest, die aufgerufen wird wenn der Benutzer den Commit Button im Zeichnen-Fenster anklickt |
| • | customtool.draw.startDraw( sType, aVertexArray ); Startet die Funktion Zeichnen |
| • | customtool.draw.showDrawForm(); Zeigt die Zeichnen-Form |
| • | customtool.draw.hideDrawForm(); Versteckt die Zeichnen-Form |
| • | customtool.draw.state(); Zeigt den aktuellen Zeichnen-Status |
Hinweis: Für detaillierte Informationen zur Konfiguration von generischen Werkzeugen siehe Kapitel Web-Integration - generisches Werkzeug.