GetTooltipLabel

This function returns the last associated label of a tooltip associated with the given equipment.

Function

string GetTooltipLabel(equipmentName: string)

Parameters

  • equipmentName (string): the name of the equipment with a tooltip to retrieve the label for.

Return Value

Returns the label as a JavaScript string, or null if the label couldn’t be retrieved.

Example

Adds ‘A’ to the label on a tooltip.

SYM3.SetOnTooltipSelectedCallback(tooltipSelected);
function tooltipSelected(equipmentName)
{
    let label = SYM3.GetTooltipLabel(equipmentName);
    if (label)
        SYM3.AttachTooltip(equipmentName, label + 'A');
}