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.

Holiday

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

Example

$heat.updateBindingOptions( "heat-map", {
    "holidays": [
        {
            "date": "25/12/2026",
            "name": "Christmas Day",
        }
    ]
} );

Options

Type:Name:Description
stringdateStates the date of the holiday (format is "DD/MM/YYYY". If you don't include the year, the holiday will be shown every year).
stringnameStates the name of the holiday.
booleanshowInViewsStates if the holiday is shown in the views (defaults to true). If true, the date will be excluded from all views.