ValueFormat

Schema: tchmi:framework#/definitions/Function

The formatting function for the display value.

It is called for each displayed value.

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 ]

ValueFormat(value: number): string;

Parameter

Name

Type

Description

value

number

The current numerical value.

Return value

Type

Description

string

The text to be displayed. HTML is not allowed here.

Origin: Radial Gauge

See also

Attribute getter: getValueFormat

Attribute setter: setValueFormat

ValueFormat 1:

Available from 1.8