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

Chart

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

Example

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

Options

Type:Name:Description:
booleanenabledStates if this view is enabled (defaults to true).
booleanshowChartYLabelsStates if the chart Y axis labels should be shown (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]).
booleanshowLineCountsStates if the activity counts should be shown in the lines (defaults to false).
booleanshowInReverseOrderStates if the chart 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).
booleanshowLineDateNumbersStates if the date day numbers should be shown (defaults to false).
booleanshowToolTipsStates if the tooltips should be shown (defaults to true).
booleanuseGradientsStates if the bar lines should use a gradient fill (defaults to false).
stringdayToolTipTextStates the tooltip format to use for a chart day (defaults to "{dddd}, {d}{o} {mmmm} {yyyy}").
booleanhighlightCurrentDayStates if the current day should be highlighted (defaults to false).
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).
booleanshowDifferencesStates if the difference percentage with the previous year's count should be shown (defaults to false).
booleanaddMonthSpacingStates if spacing and a divider line should be added between each month (defaults to false).