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

Color Ranges

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

Example

$heat.updateBindingOptions( "heat-map", {
    "views"": {
        "colorRanges": {
            "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).
booleanshowColorRangeLabelsStates if the chart X color range labels should be 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]).
booleanuseColorRangeNamesForLabelsStates if the color range names should be shown instead of the minimum for the X labels (defaults to false).
booleanshowRangeCountsStates if the range counts should be shown in the lines (defaults to false).
booleanshowInReverseOrderStates if the color ranges 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).
booleanshowRangeCountPercentagesStates if the count percentages should be shown (when count displays are enabled, defaults to true).
booleanshowRangeNamesInToolTipsStates if the range names should be shown in the tooltips (if available, defaults to true).