Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core JavaScript-API


JavaScript-Bibliothek agorum.composite/js/common

Diese JavaScript-Bibliothek agorum.composite/js/common ist eine Sammlung von Hilfsfunktionen, um häufig auftretende Aufgaben in der Entwicklung zu vereinfachen.

Verwendung


Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

let common = require('/agorum/roi/customers/agorum.composite/js/common');

Funktionen


common.watch

Die Funktion common.watch() wird verwendet, um Änderungen an bestimmten Eigenschaften eines Widgets zu überwachen und bei Änderungen eine definierte Callback-Funktion asynchron auszuführen. Sie können die Funktion etwa verwenden, um UI-Elemente automatisch zu aktualisieren, wenn sich die zugrunde liegenden Daten ändern.


Syntax

common.watch(widget, properties, callback)


Parameter

Parameter Beschreibung Pflicht Standard
widget Das Widget, dessen Eigenschaften überwacht werden. ja
properties Eine Liste der Eigenschaftsnamen, die auf Veränderungen überprüft werden. ja -
callback Die Funktion, die aufgerufen wird, sobald eine der angegebenen Eigenschaften des Widgets geändert wird. Sie wird asynchron ausgeführt, um den Haupt-Thread nicht zu blockieren. ja -


Beispiel

let aguila = require('common/aguila');
let common = require('/agorum/roi/customers/agorum.composite/js/common');

let widget = aguila.create({
  type: 'agorum.explorer.tree',
});

// Monitors the 'id' property of the widget for changes
common.watch(widget, ['id'], () => {
  console.log('watch', widget.id); // Output when the ID is changed
});

// Example how the 'id' property can be changed
widget.id = 'neueId123';
// At this point, the callback function should output the new ID.