XAxisFormat

Schema:tchmi:framework#/definitions/Function

Definition der Formatierung der X-Achsenbeschriftung.

Die ausgewählte Funktion definiert die X-Achsenbeschriftung. Sie wird für jeden angezeigten Wert der X-Achsenhauptunterteilung 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 ]

XAxisFormat(value: number): string;

Parameter

Name

Typ

Beschreibung

value

number

Der aktuelle Index des Wertes auf der X-Achse.

Rückgabewert

Typ

Beschreibung

string

Der neue Wert der X-Achsenhauptunterteilung. Hier ist kein HTML erlaubt.

Attribut-Getter

public getXAxisFormat(): TcHmi.IFunction;

Parameter

Name

Typ

Beschreibung

-

-

-

Rückgabewert

Typ

Beschreibung

TcHmi.IFunction

Der aktuelle Wert des Attributs.

Attribut-Setter

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

XAxisFormat 1:

Verfügbar ab Version 1.10