blockly > Tooltip > getCustomTooltip
Gets the custom tooltip function.
Signature:
export declare function getCustomTooltip(): CustomTooltip | undefined;
Returns:
CustomTooltip | undefined
The custom tooltip function, if defined.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["`Tooltip.getCustomTooltip()` retrieves the custom tooltip function, if one has been set."],["It returns the custom tooltip function, or `undefined` if no custom tooltip function is assigned."],["The returned function can be used to provide custom tooltips for blocks instead of the default ones."]]],["The `Tooltip.getCustomTooltip()` function retrieves the currently defined custom tooltip function. It returns either a `CustomTooltip` object, representing the function, or `undefined` if no custom tooltip function has been set. This function has no input parameters and its purpose is to provide access to the active custom tooltip.\n"]]