LabelFormat
Schema: tchmi:framework#/definitions/Function
The formatting function for the label texts.
It is called for each value in the label.
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 ]
LabelFormat(value: number): string;Parameter
Name | Type | Description |
|---|---|---|
value | The numerical value for the label. |
Return value
Type | Description |
|---|---|
The text to be displayed. HTML is not allowed here. |
Attribute getter
public getLabelFormat(): TcHmi.IFunction;Parameter
Name | Type | Description |
|---|---|---|
- | - | - |
Return value
Type | Description |
|---|---|
The current value of the attribute. |
Attribute setter
public setLabelFormat(valueNew: TcHmi.IFunction | null): void;Parameter
Name | Type | Description |
|---|---|---|
valueNew | The new value of the attribute. If null is passed, the internal default value is used. |
Return value
Type | Description |
|---|---|
void | No return value. |
 | Available from 1.8 |