API-Referenz

Namensräume

Name	Beschreibung
TcHmi	TwinCAT HMI Namensraum

Funktionen

Name	Beschreibung
tchmi_base64decode	Dekodiert einen Base64 String.
tchmi_base64encode	Kodiert einen beliebigen Text-String in einen Base64 String.
tchmi_equal	Vergleicht zwei Werte auf Wertgleichheit
tchmi_clone_object	Klont ein Datenobjekt.
tchmi_path	Saniert einen Pfad.
tchmi_create_guid	Erstellt eine Zeichenkette mit einer Globally Unique Identifier

Konstanten

Name	Beschreibung
TCHMI_ENGINEERING Verfügbar ab Version 1.12	Ist true, wenn das Framework in Designer- oder Live-View-Instanz geladen wurde.
TCHMI_DESIGNER Verfügbar ab Version 1.12	Ist true, wenn das Framework in Designer-Instanz geladen wurde.
TCHMI_LIVEVIEW Verfügbar ab Version 1.12	Ist true wenn das Framework in Live-View-Instanz geladen wurde.
TCHMI_RUNTIME Verfügbar ab Version 1.12	Ist true wenn das Framework in Runtime-Instanz geladen wurde.
TCHMI_ENABLE_DESIGNER_MODE Verfügbar ab Version 1.8 Veraltet ab Version 1.12 Bitte nutzen Sie stattdessen: TCHMI_ENGINEERING	Ist true, wenn das Framework in Designer- oder Live-View-Instanz geladen wurde.
TCHMI_ENABLE_DESIGNER_MODE_MASTER Verfügbar ab Version 1.8 Veraltet ab Version 1.12 Bitte nutzen Sie stattdessen: TCHMI_DESIGNER	Ist true, wenn das Framework in Designer-Instanz geladen wurde.
TCHMI_ENABLE_DESIGNER_MODE_SLAVE Verfügbar ab Version 1.8 Veraltet ab Version 1.12 Bitte nutzen Sie stattdessen: TCHMI_LIVEVIEW	Ist true wenn das Framework in Live-View-Instanz geladen wurde.
TCHMI_CONSOLE_LOG_LEVEL Verfügbar ab Version 1.8	Siehe TcHmi.Log

Events

Das Framework feuert sehr viele Events zu unterschiedlichen Zeitpunkten. Diese können grafisch oder per JavaScript Code (TcHmi.EventProvider.register) genutzt werden.

Jedes Control hat eine Vielzahl von Events, welche beim Control jeweils dokumentiert sind (siehe beispielsweise am Basis-Control). Aber auch das System liefert eine Reihe von Events:

Name	Beschreibung
`onConfigChanged` Verfügbar ab Version 1.12	Es gab eine Änderung in der Datei tchmiconfig.json. Dies kann nur während des Engineering vorkommen.
`onInitialized` Verfügbar ab Version 1.8	Zu diesem Zeitpunkt ist das System initialisiert und das Haupt-Control (view) wurde geladen. Andere Controls sind zu diesem Zeitpunkt evtl. noch nicht geladen oder sichtbar.
`onLocaleChanged` Verfügbar ab Version 1.8	Die Sprache der aktuellen Anzeige wurde gesetzt oder geändert.
`onThemeDataChanged` Verfügbar ab Version 1.10	Das Themesystem hat neue Werte oder CSS Styles. Zusätzlich wird dieses Event gefeuert, wenn eine neue Schriftart geladen wurde. Dies kann bei bisher nie angezeigten Zeichen auf dem Bildschirm zu jeder Zeit passieren.
`onUserChanged` Verfügbar ab Version 1.12	Ein neuer Benutzer wurde eingeloggt.
`onUserDataChanged` Verfügbar ab Version 1.12	Ein neuer Benutzer wurde eingeloggt und / oder dessen Konfiguration (Zeitzone, …) des aktuellen Benutzers ist dem System nun bekannt oder hat sich geändert.
`onUserInGroupChanged` Verfügbar ab Version 1.8	Die Gruppenzugehörigkeit des aktuellen Benutzers ist dem System nun bekannt oder hat sich geändert.
`onWebSocketOpened` Verfügbar ab Version 1.8	Die Kommunikation zum Server wurde erfolgreich aufgebaut.
`onWebSocketClosed` Verfügbar ab Version 1.8	Die Kommunikation zum Server wurde unterbrochen. Im Normalbetrieb wird die Verbindung automatisch wieder hergestellt.