XAxisFormat

Schema:tchmi:framework#/definitions/Function

Definition of the formatting of the X-axis labels.

The selected function defines the X-axis labels. It is called for each displayed value of the main X-axis subdivision. To do this, it receives the index of the BarGraphData attribute.

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 ]

XAxisFormat(value: number): string;

Parameter

Name

Type

Description

value

number

The current index of the value on the X-axis.

Return value

Type

Description

string

The new value of the main X-axis subdivision. HTML is not allowed here.

Origin: Horizontal Bar Chart

See also

Attribute getter: getXAxisFormat

Attribute setter: setXAxisFormat

XAxisFormat 1:

Available from version 1.12.746