Events
Mit Hilfe von Events können Sie erreichen, dass Teile Ihres Codes ausgeführt werden, sobald bestimmte Ereignisse eintreffen.
Folgende Events sind im nachfolgenden erklärt:
Events.onProjectLoaded
Das onProjectLoaded-Event wird einmalig ausgelöst, sobald das Projekt geladen, und das mainInterface zur Verfügung steht.
Erst nach diesem Event ist es möglich, mit dem mainInterface zu kommunizieren und z.B. Variablen zu manipulieren.
Events.onProjectLoaded(function);
Als function Parameter muss eine Funktion übergeben werden, die beim Auslösen dieses Events aufgerufen werden soll. Beim Auslösen des Events wird diese Funktion ohne Parameter aufgerufen.
Events.onPageLoaded
Das onPageLoaded-Event wird nach dem Laden einzelner Seiten ausgelöst.
Events.onPageLoaded(function);
Als function Parameter muss eine Funktion übergeben werden, die beim Auslösen dieses Events aufgerufen werden soll. Beim Auslösen des Events wird diese Funktion mit dem Seitennamen als einzigen Parameter aufgerufen.
Events.onPageLoaded(selector, function);
Als selector Parameter muss der Name einer Seite oder ein regulärer Ausdruck übergeben werden. Wird eine Seite geladen, und der Name der Seite stimmt mit dem selector überein, wird die als function übergeben Funktion aufgerufen.
Als function Parameter muss eine Funktion übergeben werden, die beim Auslösen dieses Events aufgerufen werden soll. Beim Auslösen des Events wird diese Funktion mit dem Seitennamen als einzigen Parameter aufgerufen.
Events.onVarChanged
Das onVarChanged-Event wird verwendet, um auf die Änderung einer oder mehrerer Variable zu reagieren.
Events.onVarChanged(selector, function);
Als function Parameter muss eine Funktion übergeben werden, die beim Auslösen dieses Events aufgerufen werden soll.
Beim Auslösen des Events wird der Funktion ein Parameter mit folgender Struktur übergeben:
|
args[„variable“][„name“] (args.variable.name) |
Enthält den Namen der Variable. |
|
args[„variable“][„datasource_name“] (args.variable.name) |
Enthält den Namen der Datenquelle zur Variable. |
|
args[„variable“][„value“] (args.variable.value) |
Enthält den aktuellen Wert der Variable. |
|
args[„variable“][„lastvalue“] (args.variable.lastvalue) |
Enthält den alten Wert der Variable. |
|
args[„variable“][„quality“] (args.variable.quality) |
Enthält die aktuelle Quality der Variable. |
|
args[„variable“][„timestamp“] (args.variable.timestamp) |
Enthält den Zeitpunkt der letzten Änderung. |
Als selector Parameter muss der Name einer Variable oder ein regulärer Ausdruck übergeben werden. Ändert sich eine Variable, und der Name der Variable stimmt mit dem selector überein, wird die als function übergeben Funktion aufgerufen.
Events.onVariablesInitialized
Das onVariablesInitialized-Event wird einmalig ausgelöst, sobald alle Variablen initialisiert wurden. Dieses Event tritt kurz nach dem onProjectLoaded Event auf.
Events.onVariablesInitialized(function);
Als function Parameter muss eine Funktion übergeben werden, die beim Auslösen dieses Events aufgerufen werden soll. Beim Auslösen des Events wird diese Funktion ohne Parameter aufgerufen.