Heat.js - Documentation - Options

Below is the JSON format and properties that can be used for the configuration options.

Download Now

v4.1.1 - 25th Jul 2024
JSON Properties

Options:

Type: Name: Description:
boolean safeMode States if safe-mode is enabled (errors will be ignored and logged only, defaults to true).
Object domElementTypes The DOM element types to lookup (can be either an array of strings, or a space-separated string, and defaults to "*").


Options - Strings:

Category: Type: Name: Description:
text string stText The day ordinal text for "st".
text string ndText The day ordinal text for "nd".
text string rdText The day ordinal text for "rd".
text string thText The day ordinal text for "th".
text string backButtonText The text that should be shown for the "Back" button.
text string nextButtonText The text that should be shown for the "Next" button.
text string refreshButtonText The text that should be shown for the "Refresh" button.
text string exportButtonText The text that should be shown for the "Export" button.
text string lessText The text that should be shown for the "Less" label.
text string moreText The text that should be shown for the "More" label.
text string[] monthNames The month names (defaults to '[ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ]').
text string[] dayNames The day names (defaults to '[ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ]').
text string dateText The text that should be shown for the "Date" CSV header.
text string countText The text that should be shown for the "Count" CSV header.
text string mapText The text that should be shown for the "Map" label.
text string chartText The text that should be shown for the "Chart" label.
text string noChartDataMessage States the message that should be shown on the chart view when there is no data (defaults to "There is currently no data to view.").
text string statisticsText The text that should be shown for the "Statistics" label.
text string noStatisticsDataMessage States the message that should be shown on the chart view when there is no data (defaults to "There is currently no statistics to view.").
text string unknownTrendText The text that should be shown for the "Unknown" trend type button.
text string importButtonText The text that should be shown for the "Import" button.
text string noMapDataMessage States the message that should be shown on the map view when there is no data (defaults to "There is currently no data to view.").
text string objectErrorText States the error message that should be shown for object parsing errors (defaults to "TErrors in object: {{error_1}}, {{error_2}}").
text string attributeNotValidErrorText States the error message that should be shown for attributes errors (defaults to "The attribute '{{attribute_name}}' is not a valid object.").
text string attributeNotSetErrorText States the error message that should be shown for attribute not errors (defaults to "The attribute '{{attribute_name}}' has not been set correctly.").
text string closeToolTipText States the text that should be shown for the tooltip "Close".
text string configurationToolTipText States the text that should be shown for the tooltip "Configuration".
text string configurationTitleText States the text that should be shown for the title bar "Configuration".
text string visibleMonthsText States the text that should be shown for the "Visible Months" label header.
text string visibleDaysText States the text that should be shown for the "Visible Days" label header.
text string dataText States the text that should be shown for the "Data" label.
text string colorRangesText States the text that should be shown for the "Color Ranges" label.
text string yearText States the text that should be shown for the "Year" label.
text string daysText States the text that should be shown for the "Days" label.
text string noDaysDataMessage States the message that should be shown on the days view when there is no data (defaults to "There is currently no days to view.").
text string backButtonSymbolText The text that should be shown for the "Back" symbol button (defaults to "←").
text string nextButtonSymbolText The text that should be shown for the "Next" symbol button (defaults to "→").
text string refreshButtonSymbolText The text that should be shown for the "Refresh" symbol button (defaults to "↻").
text string exportButtonSymbolText The text that should be shown for the "Export" symbol button (defaults to "↓").
text string importButtonSymbolText The text that should be shown for the "Import" symbol button (defaults to "↑").