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

Months

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

Example

$heat.updateBindingOptions( "heat-map", {
    "views"": {
        "months": {
            "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]).
booleanshowMonthCountsStates if the month counts should be shown in the lines (defaults to false).
booleanshowInReverseOrderStates if the months 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).
booleanuseGradientsStates if the bar lines should use a gradient fill (defaults to false).
booleanuseDifferentOpacitiesStates if the color opacities for each month should be different (defaults to false).
booleanshowMonthCountPercentagesStates if the count percentages should be shown (when count displays are enabled, defaults to true).
booleanshowStackedColorRangesStates if the bar should show the stacked color range levels (defaults to true).
stringmonthToolTipTextStates the tooltip format to use for a month item (defaults to "{mmmm} {yyyy}").
booleanhighlightCurrentMonthStates if the current month should be highlighted (defaults to false).