YAxisFormat
Schema:tchmi:framework#/definitions/Function
Definition of the formatting of the Y-axis labels.
The selected function defines the Y-axis labels. It is called for each displayed value of the main Y-axis subdivision.
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 ]
YAxisFormat(value: number): string;Parameter
Name | Type | Description |
|---|---|---|
value | The current value on the Y-axis. |
Return value
Type | Description |
|---|---|
The new value of the main Y-axis subdivision. HTML is not allowed here. |
Attribute getter
public getYAxisFormat(): TcHmi.IFunction;Parameter
Name | Type | Description |
|---|---|---|
- | - | - |
Return value
Type | Description |
|---|---|
The current value of the attribute. |
Attribute setter
public setYAxisFormat(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 version 14 |