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

Line

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

Example

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

Options

Type:Name:Description:
booleanenabledStates if this view is enabled (defaults to true).
booleanshowMonthNamesStates if the month names are shown (defaults to true).
number[]monthsToShowStates the months that should be shown (defaults to [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]).
number[]daysToShowStates the days that should be shown (defaults to [1, 2, 3, 4, 5, 6, 7]).
booleanshowInReverseOrderStates if the lines should be shown in reverse order (defaults to false).
booleankeepScrollPositionsStates if the scroll positions should be maintained when the view is redrawn (or moving year to year, defaults to false).
booleanshowToolTipsStates if the tooltips should be shown (defaults to true).
stringdayToolTipTextStates the tooltip format to use for each line (defaults to "{dddd}, {d}{o} {mmmm} {yyyy}").
booleanshowYearsInMonthNamesStates if the year should be shown in the month name (when "startMonth" is set, defaults to true).
booleanshowCountsInToolTipsStates if the day counts should be included in the tooltips (defaults to true).
booleanshowDifferencesInToolTipsStates if the difference percentage with the previous year's count should be shown in the tooltips (defaults to true).