Parameter

Details

searchTerm

Hier soll die Benutzereingabe bzw. der Suchbegriff übergeben werden

urlTemplate

In diesem Parameter soll die Vorlage (Template) für die aufzurufende Url übergeben werden. Die Aufrufmöglichkeiten sind bei den jeweiligen Clients dokumentiert. Diese Vorlage kann die drei Template-Variablen $mapId$, $layerId$ und $featureId$ enthalten die für jedes Ergebnis inividuell ersetzt werden. Dieser Mechanismus ermöglicht eine maximale flexibilität bei der Konfiguration der Karte. Damit sind alle Funktionalitäten der verschiedenen Clients in Kombination mit sämtlichen Netzwerkkonfigurationsmöglichkeiten verwendbar.

useDefaultIcons

Dieser Parameter ist optional. Hier kann gesteuert werden, ob die atlasFX Default Icons verwendet werden sollen, falls kein Icon am Layer konfiguriert wurde. Gültige Werte sind hier true oder false.

<atlasFX-url>

http://roadshow.alta4cloud.com/atlasfx

Dies ist die Url unter der der Context der atlasFX-Webapplication verfügbar ist.

<mapId>

530

In diesem Beispiel verwenden wir die Karte mit der Id 530. Diese Id identifiziert eine atlasFX-Karte. Sie kann einfach im atlasFX CMS abgelesen werden.

<atlasFX-url>

http://roadshow.alta4cloud.com/atlasfx

This is the url where the context of atlasFX web application is available.

<iconId>

4

In this example we try to call the icon  with the ID 4.

configureLayerQuery

• layerId: int

• config: Map

• suppressRefresh?: boolean

Dies ermöglicht es den Query für Feature-Layer zu spezifizieren.

Beispiel Attribute für config:

• *where: string => Eine SQL Where-Klausel um die Feature einzugrenzen

• orderByFields: string => ?

• outFields: string => Kommaseparierte Liste an Feldern, die zusätzlich geliefert werden sollen. * gibt alle Felder zurück.

• geometry: Map => Wird automatisch auf den Map Extent gesetzt. überschreibt man es mit null wird der Extent ignoriert.

setLayerFilter

• layerId: int

• whereExpression: string

• suppressRefresh?: boolean

Dies ist ein Alias für configureLayerQuery(layerId, {where: whereExpression}, suppressRefresh);

setLayerFieldFilter

• layerId: int

• fieldName: string

• filter: SqlGenFilter

• suppressRefresh?: boolean

string

Unterschiede zu setLayerFilter:

• Es wird ein SqlGenFilter objekt benötigt, kein SQL String.

• Filter werden an die Kombination <layerId und Feldname> gebunden, nicht nur an layerId.

  • Dadurch können Filter unabhängig voneinander für verschiedene Feldnamen definiert werden.

  • Diese werden automatisch durch sqlGen.AND und-verknüpft.

• Bei Aufruf wird ein Dojo Event veröffentlicht. Man kann auf dieses hören:

  • topic.subscribe(atlas.events.ATLAS_LAYER_FIELD_FILTER_UPATE, function(layerId, fieldName, filter, finalWhere) {...});

• Zurückgegeben wird die berechnete Where-Klausel für den Layer (als string).

getExtentWebMercator

esri/geometry/Extent

Liefert den Extent der Karte in WebMercator-Koordinaten.

getExtentGeographic

esri/geometry/Extent

Liefert den Extent der Karte in Längen- und Breitengrad.

setCenter

• x: number

• y: number

dojo/Deferred

Zentriert die Karte auf den übergebenen Punkt. Die Koordinaten müssen im gleichen Koordinatensystem wie die Map sein.

setCenterWgs84

• lat: number

• long: number

dojo/Deferred

Zentriert die Karte auf den übergebenen Punkt. Die Koordinaten sind als Längen- und Breitengrad anzugeben.

setScale

• scale: number

dojo/Deferred

Setzt die Skalierung der Karte. Wenn die Karte im Maßstab 1 : 50.000 angezeigt werden soll, muss für den Parameter scale der Wert 50000 gesetzt sein.

getScale

number

Liefert die aktuelle Skalierung der Karte.

setCenterAndZoom

• x: number

• y: number

• levelOrFactor: number

dojo/Deferred

Kombination aus obigen Funktionen, wobei die Koordinaten aus dem Koordinatensystem der Karte angenommen werden und wahlweise ein konfigurierter Zoomlevel oder Faktor angegeben wird.

setCenterAndScale

• mapPoint: esri/geometry/Point

• scale: number

dojo/Deferred

Wie oben. Hier wird aber ein Skalierungsfaktor angegeben.

setInfoWindowLinkClickCallback

• callback: function

Wird in einem InfoBubble ein Link aufgerufen wird zuerst die Callback-Methode aufgerufen. callback(url): Callback gibt die angeklickte URL zurück. Die Callback-Methode muss false zurück geben, falls das Ausführen des Links unterdrückt werden soll.

wgs84ToWebMercator

• lat: number

• lon: number

esri/geometry/Point

Rechnet Längen- und Breitengrad in WebMercator-Koordinaten um.

refreshLayers

Veranlasst ein Neuzeichnen aller Layer.

registerGraphicCallback

• layerId: int

• callback: function

Registriert auf dem angegebenen Layer einen Klick-Callback für darauf befindliche Grafiken.

removeGraphicCallback

• layerId: int

Entfernt die mit obiger Funktion registrierten Callback-Routinen.

showFeature

• layerId: int

• featureId: int

• showInfoBubble: boolean,

• scale: number

Zentriert die Karte auf das durch layerId und featureId identifizierte Feature. Mit dem booleschen Parameter showInfoBubble kann eingestellt werden, ob das zugehörige Info-Fenster angezeigt werden soll, sofern diese Eigenschaft des Features konfiguriert ist. Der scale-Parameter ist nur für Punktfeatures definiert und optional. Geometrien, die eine Ausdehnung besitzen (Flächen, Linien), werden immer in maximaler Zoom-Stufe dargestellt aber so, dass sie noch ganz auf der Karte liegen.

setMouseFeatureInteraction

• layerTypes: string | Array<string>

• event: string

• procedure: string

• handler: function

Erweitert oder ersetzt die voreingestellte Maus-Interaktion mit Kartenfeatures. Zulässige Parameterwerte:

• layerTypes: Die zu überwachenden Layer Typen.

  • Einer der folgenden Strings oder eine Kombination daraus als Array:
    POINT, LINE, POLYGON, CLUSTER, SINGLE_FEATURE_CLUSTER
    Die letzten beiden Werte beziehen sich auf geclusterte Maßstabsbereiche. Es wird unterschieden zwischen „echten“ Clustern und solchen, die nur ein einzelnes Feature enthalten und wie ein normales Punktfeature dargestellt werden.

• event: Die zu behandelnden Mausereignisse.

  • Einer der folgenden Strings:
    mouseOver, mouseOut, click

• procedure: Wie die übergebene handler Funktion eingehängt werden soll.

  • before, after, replace
    Für den Fall, dass der eingehängte Handler nach der default-Funktion ausgeführt wird oder diese ersetzt, wird das Maus-Event dem handler übergeben.

enableOptionalTool

• toolIdentifier: string

• toolPublicName: string

• config: Map

• callback: function(tool)

Lädt und schaltet ein optionales Tool ein.

Der Aufrufer kann unter dem durch toolPublicName angegebenen Namen ein Modul (toolIdentifier) registrieren und mit einer Konfiguration config initialisieren. Nach erfolgreicher Initialisierung wird der callback aufgerufen und das Tool kann benutzt werden.

Gibt es verschiedene Caller, müssen sie verschiedene global gültige Namen verwenden oder die Funktion enableOptionalToolEx benutzen.

enableOptionalToolEx

• toolIdentifier: string

• config: Map

• callback: function(tool)

Ähnlich zu enableOptionalTool. Hierbei wird das Tool jedoch nur einmal unter dem Namen toolIdentifier registriert und initialisiert. Bei nachfolgenden Aufrufen wird dann lediglich eine neue callback-Funktion registriert und aufgerufen.

init

• config: Map

-

Initialisiert Platzhalter entsprechend der Konfiguration. Siehe Initialisierung.

replace

• str: string

string

Ersetzt Platzhalter im übergebenen String. Siehe Platzhalter ersetzen.

baseUrl

• suffix: string

string

Alias für replace("{atlas}") + suffix

handleRelativeBaseUrl

• url: string

string

Ersetzt ../ durch baseUrl("/")

jsUrl

• suffix: string

string

Alias für replace("{atlas_js}") + suffix

springUrl

• suffix: string

string

Alias für replace("{atlas_spring}") + suffix

handleRelativeSpringUrl

• url: string

string

Ersetzt ../spring/rest/ durch restUrl("/")

restUrl

• suffix: string

string

Alias für replace("{atlas_rest}") + suffix

restIconUrl

• iconId: string

string

Alias für restUrl("/icons/image/") + iconId

proxyUrl

• suffix: string

string

Alias für replace("{atlas_proxy}") + suffix

localUrl

• suffix: string

string

Alias für replace("{local}") + suffix

strEndswith

• str: string

• suffix: string

boolean

Prüfen, ob ein String mit einem suffix endet.

getParameters

Map<string, string>

Gibt eine Map zurück, welche die GET Parameter wiederspiegelt.

transformToAssocArray

• str: string

Map<string, string>

Nimmt einen String, der wie GET Parameter zusammen gesetzt ist und erzeugt daraus eine Map.

backendUrl

Wird aus dem Script Tag von atlas_loader.js erzeugt

Die Url zum atlasFX Backend

dojoTheme

claro

Name des Dojo Themes

supportedBrowsers

Map

siehe atlas_loader.js

Eine Map an unterstützten Browser-Versionen. Hier kann die minimalversion und der Anzeigestring konfiguriert werden. Ist die minVersion kleiner als die von atlasFX, so wird die von atlasFX genommen. Siehe atlas_loader.js für ein Beispiel.

noAtlas

boolean

false

Wenn dieser Wert true ist, wird nur dojo geladen, aber kein atlasFX Client.

useLogger

boolean

false

Wenn dieser Wert true ist, wird ein Loggerfenster zur verfügung gestellt, welches über Strg + Shift + Backspace einzusehen ist. Bei einem Wer von false warden Meldungen nur in die Browserkonsole ausgegeben.

extraConfigs

Array<string | function>

-

Ein Array an URLs (Javascript oder CSS Dateien) und/oder Funktionen die Synchronisiert geladen bzw. aufgerufen werden nachdem die atlasFX Konfigurationsdateien geladen wurden aber bevor weitere esri, dojo und atlasFX Resourcen geladen werden.

resources

Array<string | function>

-

Ein Array an URLs (Javascript oder CSS Dateien) und/oder Funktionen die Synchronisiert geladen bzw. aufgerufen werden nachdem die atlasFX Resourcen geladen wurden aber bevor atlasFX initialisiert wird.

templateParentId

string

atlasBody

Die ID des HTML Elements, in welches der atlas Eingebettet werden soll.

getTemplateLoader

function

-

Wird aufgerufen um den Dojo Klassenpfad zu bekommen, welcher genutzt wird um das atlasFX Template zu laden.

onBrowserCheck

function

Eine Implementierung, die den Benutzer warnt.

Dieser Callback wird aufgerufen sobald der Browserchecker initialisiert ist. Dieser Callback erhält 2 Parameter:

• browserChecker: Eine Instanz des BrowserCheckers.

• continueLoad: Ein Callback, der Aufgerufen werden muss, sobald es weiter gehen soll mit dem Laden.

onResourcesLoaded

function

-

Wird aufgerufen nachdem alle Ressourcen geladen wurden.

mapReadyCallbacks

Array<function>

-

Ein Array an MapReady Callbacks, die direkt vor onResourcesLoaded() zum atlasFX hinzugefügt werden.