TooltipFormat
Definition of the formatting of the tooltips.
Schema: tchmi:framework#/definitions/Function
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 | The numerical value for the x-coordinate. | |
valueY | The numerical value for the y-coordinate. |
Return value
Type | Description |
|---|---|
The tooltip to be displayed. HTML is allowed here. |
Attribute getter
public getTooltipFormat(): TcHmi.IFunction;Parameter
Name | Type | Description |
|---|---|---|
- | - | - |
Return value
Type | Description |
|---|---|
The current value of the attribute. |
Attribute setter
public setTooltipFormat(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 1.10 |