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.

side_navigation

Yearly Statistics

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

Example

$heat.updateBindingOptions( "heat-map", {
    "yearlyStatistics": {
        "enabled": true
    }
} );

Options

Type:Name:Description:
booleanenabledStates if the yearly statistics should be shown (defaults to false).
booleanshowTodayStates if the "Today" box should be shown in the yearly statistics (defaults to true).
booleanshowThisWeekStates if the "This Week" box should be shown in the yearly statistics (defaults to true).
booleanshowThisMonthStates if the "This Month" box should be shown in the yearly statistics (defaults to true).
booleanshowThisYearStates if the "This Year" box should be shown in the yearly statistics (defaults to true).
booleanshowOnlyForCurrentYearStates if the yearly statistics should only be shown for the current year (defaults to false).
booleanshowPercentagesStates if the yearly statistics should show the value percentages (defaults to true).