TooltipFormat
Definition der Formatierung der Tooltips.
Schema: tchmi:framework#/definitions/Function
Die ausgewählte Funktion definiert die Tooltip Anzeige. Sie wird aufgerufen, sobald der Mauszeiger auf einem Punkt und/oder einem Fehler liegt. Dazu erhält sie den aktuellen Zeitstempel der Maus, der in Millisekunden angegeben wird, eine Liste mit Punkten und eine Liste mit Fehlern. Die jeweilige Liste ist leer, wenn es keine Punkte oder Fehler an dieser Stelle gibt.
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(actTime: number, points: TcHmiTrendLineChart.TooltipInformationObject[], errors: TcHmiTrendLineChart.TooltipErrorInformationObject[]): string;
Parameter
Name | Typ | Beschreibung |
---|---|---|
actTime | Der aktuelle Zeitstempel der Mausposition in Millisekunden seit dem 1.1.1970. | |
points | Die aufgezeichneten Punkte (als Array), die an der Mausposition liegen (innerhalb des Punkteradius). | |
errors | Die aufgezeichneten Fehler (als Array), die an der Mausposition liegen. |
Rückgabewert
Typ | Beschreibung |
---|---|
Der Tooltip der angezeigt werden soll. Hier ist HTML erlaubt.. |
Herkunft: Trend Line Chart
Siehe auch
Attribut-Getter: getTooltipFormat
Attribut-Setter: setTooltipFormat
Verfügbar ab Version 1.10 |