TooltipFormat

Schema: tchmi:framework#/definitions/Function

Definition of the formatting of the tooltips.

This is called when the tooltip is displayed.

A function must fulfill the following signature in order to be offered in the engineering. The parameters mentioned here are set by the control. Further parameters are possible and can be specified per instance in the engineering.

[ Function ]

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

Parameter

Name

Type

Description

valueX

number

The numerical value for the x-coordinate.

valueY

number

The numerical value for the y-coordinate.

Return value

Type

Description

string

The tooltip to be displayed. HTML is allowed here.

Origin: Line Chart

See also

Attribute getter: getTooltipFormat

Attribute setter: setTooltipFormat

TooltipFormat 1:

Available from version 1.10