Heat.js - Documentation - Options
Below is the JSON format and properties that can be used for the configuration options.
Download Now
v3.1.1 - 7th May 2024
Below is the JSON format and properties that can be used for the configuration options.
Download Now
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 "*"). |
Type: | Name: | Description: |
---|---|---|
string | stText | The day ordinal text for "st". |
string | ndText | The day ordinal text for "nd". |
string | rdText | The day ordinal text for "rd". |
string | thText | The day ordinal text for "th". |
string | backButtonText | The text that should be shown for the "Back" button. |
string | nextButtonText | The text that should be shown for the "Next" button. |
string | refreshButtonText | The text that should be shown for the "Refresh" button. |
string | exportButtonText | The text that should be shown for the "Export" button. |
string | lessText | The text that should be shown for the "Less" label. |
string | moreText | The text that should be shown for the "More" label. |
string[] | monthNames | The month names (defaults to '[ "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" ]'). |
string[] | dayNames | The day names (defaults to '[ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ]'). |
string | dateText | The text that should be shown for the "Date" CSV header. |
string | countText | The text that should be shown for the "Count" CSV header. |
string | mapText | The text that should be shown for the "Map" label. |
string | chartText | The text that should be shown for the "Chart" label. |
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."). |
string | statisticsText | The text that should be shown for the "Statistics" label. |
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."). |
string | unknownTrendText | The text that should be shown for the "Unknown" trend type button. |
string | importButtonText | The text that should be shown for the "Import" button. |
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."). |
string | objectErrorText | States the error message that should be shown for object parsing errors (defaults to "TErrors in object: {{error_1}}, {{error_2}}"). |
string | attributeNotValidErrorText | States the error message that should be shown for attributes errors (defaults to "The attribute '{{attribute_name}}' is not a valid object."). |
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."). |
string | closeToolTipText | States the text that should be shown for the tooltip "Close". |
string | configurationToolTipText | States the text that should be shown for the tooltip "Configuration". |
string | configurationTitleText | States the text that should be shown for the title bar "Configuration". |
string | visibleMonthsText | States the text that should be shown for the "Visible Months" label header. |
string | visibleDaysText | States the text that should be shown for the "Visible Days" label header. |
string | dataText | States the text that should be shown for the "Data" label. |
string | colorRangesText | States the text that should be shown for the "Color Ranges" label. |
string | yearText | States the text that should be shown for the "Year" label. |
string | daysText | States the text that should be shown for the "Days" label. |
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."). |