unregisterEventHandler

[ Funktion ]

public unregisterEventHandler(
    name: 'animationstart' | 'animationend' | 'animationiteration',
    callback: (event: TcHmi.Animation.AnimationEvent) => void
): this;

Deregistriert einen Callback für ein Animationsevent.

Parameter

Name	Typ	Beschreibung
name	string	Der Name des zuvor registrierten Events. `'animationstart'` wird ausgelöst, wenn die Animation startet, nach Ablauf der Verzögerung. `'animationend'` wird ausgelöst, wenn die Animation endet. `'animationiteration'` wird ausgelöst, wenn die Animation in eine neue Wiederholung startet.
callback	(event: TcHmi.Animation.AnimationEvent) => void	Die zuvor registrierte Funktion. Muss referenzgleich zu dem callback Parameter sein. der zuvor bei registerEventHandler übergeben wurde.

Name

Typ

Beschreibung

name

string

Der Name des zuvor registrierten Events.

'animationstart' wird ausgelöst, wenn die Animation startet, nach Ablauf der Verzögerung.

'animationend' wird ausgelöst, wenn die Animation endet.

'animationiteration' wird ausgelöst, wenn die Animation in eine neue Wiederholung startet.

callback

(event: TcHmi.Animation.AnimationEvent) => void

Die zuvor registrierte Funktion. Muss referenzgleich zu dem callback Parameter sein. der zuvor bei registerEventHandler übergeben wurde.

Rückgabewert

Typ	Beschreibung
TcHmi.Animation	Diese Methode gibt ihr Elternobjekt zurück, um eine Aneinanderkettung von Methodenaufrufen zu ermöglichen.

Beispiel – JavaScript

var animation = new TcHmi.Animation('ViewDesktopBeckhoffLogo', '');
var eventHandler = function (event) {
    console.log('Animation started: ' + event.animationName);
};
animation.registerEventHandler('animationstart', eventHandler);
var handlers = animation.eventHandlers(); // [{ name: 'animationstart', callback: f(event) }]
animation.unregisterEventHandler('animationstart', eventHandler);
handlers = animation.eventHandlers(); // []

	Verfügbar ab Version 1.8