LabelFormat

Schema: tchmi:framework#/definitions/Function

Die Formatierungsfunktion für die Beschriftungs-Texte.

Sie wird für jeden Wert im Label 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 ]

LabelFormat(value: number): string;

Parameter

Name

Typ

Beschreibung

value

number

Der Zahlenwert für das Label.

Rückgabewert

Typ

Beschreibung

string

Der Text der angezeigt werden soll. Hier ist kein HTML erlaubt.

Attribut-Getter

public getLabelFormat(): TcHmi.IFunction;

Parameter

Name

Typ

Beschreibung

-

-

-

Rückgabewert

Typ

Beschreibung

TcHmi.IFunction

Der aktuelle Wert des Attributs.

Attribut-Setter

public setLabelFormat(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.

LabelFormat 1:

Verfügbar ab Version 1.8