TooltipFormat

Schema: tchmi:framework#/definitions/Function

Definition der Formatierung der Tooltips.

Sie wird bei der Darstellung des Tooltips aufgerufen.

Eine Funktion muss folgende Signatur erfüllen, um im Engineering angeboten zu werden. Die hier erwähnten Parameter werden vom Control gesetzt. Weitere Parameter sind möglich und können im Engineering pro Instanz angegeben werden.

[ Funktion ]

TooltipFormat(valueX: number, valueY: number): string;

Parameter

Name	Typ	Beschreibung
valueX	number	Der Zahlenwert für die X-Koordinate.
valueY	number	Der Zahlenwert für die Y-Koordinate.

Rückgabewert

Typ	Beschreibung
string	Der Tooltip der angezeigt werden soll. Hier ist HTML erlaubt.

Attribut-Getter

public getTooltipFormat(): TcHmi.IFunction;

Parameter

Name	Typ	Beschreibung
-	-	-

Rückgabewert

Typ	Beschreibung
TcHmi.IFunction	Der aktuelle Wert des Attributs.

Attribut-Setter

public setTooltipFormat(valueNew: TcHmi.IFunction | null): void;

Parameter

Name	Typ	Beschreibung
valueNew	TcHmi.IFunction, null	Der neue Wert des Attributs. Wird null übergeben, so wirkt der interne Standardwert.

Rückgabewert

Typ	Beschreibung
void	Kein Rückgabewert.

	Verfügbar ab Version 1.10