Documentation

This page documents the functionality of Heat.js, including its parameters, usage examples, and expected outputs. It serves as a reference for developers to implement and troubleshoot effectively.

ToolTip

Explore this complete list of Heat.js binding options to easily set up, customize, and update your tooltip settings on the fly.

Example

$heat.updateBindingOptions( "heat-map", {
    "tooltip": {
        "delay": 1000
    }
} );

Options

Type:Name:Description:
numberdelayStates how long the tooltip should wait (in milliseconds) until it's shown (defaults to 750).
booleanoverrideTitleStates if the built-in custom tooltip layout should be used instead of the "title" attribute (defaults to true).
stringcustomAttributeNameStates the name of a custom attribute to apply against all elements that used a "title" tooltip attribute (defaults to empty string).
stringcustomAttributeValueStates the value to use for the custom attribute applied against all elements that used a "title" tooltip attribute (defaults to empty string).