add

[ Funktion ]

public static add(
    control: TcHmi.Controls.System.baseTcHmiControl, 
    element: JQuery | undefined | null, 
    options?: TopMostLayer.IOptions
): boolean;

Hängt ein HTML-Element in den Overlaybereich über der normalen Visualisierung. Diese Funktion ist gedacht zur Nutzung aus einem Control heraus. Wird dieses vom DOM entfernt (detach) so werden auch alle Elemente aus dem TopMostLayer entfernt.

Eine Referenz zum Element sollte im Control gespeichert werden um die remove() Funktion aufrufen zu können.

Parameter

Rückgabewert

Verfügbar ab Version 1.10

Beispiel - JavaScript

var myPopup = $('<div style="background:white;padding:10px;">Hello World<div>');
TcHmi.TopMostLayer.add(this, myPopup, {
    centerHorizontal: true,
    centerVertical: true,
    removeCb: (data) => {
        if (data.canceled) {
            // user clicked on background
        }
    }
});