functions

Typ: Array von JSON-Objekten
Erforderlich: Nein

"functions": [
   {
      "name": "customFunction",
      "displayName": "customFunction",
      "visible": true,
      "description": "This is a sample for a function that can be called.",
      "category": "Actions",
      "params": [],
      "type": null,
      "heritable": true,
      "searchTerms": []
   }
]

Diese Eigenschaft definiert Funktionen des Controls welche unabhängig von Attributen sind. Die Funktionen können optional Übergabeparameter oder einen Rückgabewert erhalten. Jede Funktion muss mit dem gleichen Namen in der Source.js vorhanden sein, andernfalls gibt es eine Fehlermeldung in der Konsole des Browsers und die Funktion wird nicht ausgeführt.

Ein JSON-Objekt für eine Funktion enthält folgende Eigenschaften:

• name {String}: Interner Name der Funktion.
• displayName {String}: Name der Funktion, der im Engineering angezeigt wird.
• description {String}: Beschreibung der Funktion, die im Engineering beim Mouseover als Tooltip angezeigt wird.
• category {String}: Kategorie der Funktion, unter der die Funktion im Actions and Conditions Editor im Engineering angezeigt wird.
• params {JSON-Objekt}, nicht erforderlich: Übergabeparameter der Funktion.
• type {String, TwinCAT HMI Datentyp}: Rückgabewert der Funktion. Der Rückgabewert muss vom Typ eines TwinCAT HMI Datentyps sein.
• heritable {Boolean}: Diese Eigenschaft definiert, ob die Funktion an abgeleitete Klassen vererbt werden soll.
• searchTerms {Array von Strings}, nicht erforderlich: Diese Eigenschaft definiert Suchbegriffe für das Engineering, welche die Suchfunktion innerhalb des Actions & Conditions Editors optimieren soll. Dadurch ist es möglich, die Funktion über andere Begriffe als den Funktionsnamen zu finden. Werden z. B. die Strings „MyFunction“ und „1234“ in das Array gefügt, kann die Funktion auch unter diesen Begriffen gefunden werden.

Das nachfolgende Bild zeigt beispielhaft zwei Framework Control Funktionen im Engineering, die beide keinen Rückgabewert besitzen und die eine Funktion optionale Übergabeparameter enthält.