- Information
- License (MIT)
- Recent Changes
- Supported Languages
- Supported Export Types
- Supported Import Types
- Setup
- Getting Started
- CDN Links
- Navigation
- Shortcut Keys
- API
- Public Functions
- Configuration
- Main Options
- Text Options
- Binding Options
- Basic Options
- Side Menu
- Title Bar
- Yearly Statistics
- Description
- Guide
- Zooming
- ToolTip
- Holiday
- Dynamic Color Range
- Color Range
- Date Formatting
- Custom Triggers
Basic Options
Explore this complete list of the basic Heat.js binding options used set up, customize, and update your heat map settings on the fly.
Example
$heat.updateBindingOptions( "heat-map", {
defaultView: "line"
} );| Type: | Name: | Description: |
|---|---|---|
| boolean | exportOnlyDataBeingViewed | States if only the data being viewed should be exported (defaults to true). |
| number | defaultYear | States the year that should be shown when the heat map is rendered for the first time (defaults to the current year). |
| string | defaultView | States the view that should be shown by default (defaults to "map", also accepts "line", "chart", "days", "months", "color-ranges"). |
| string | exportType | States the export file type that should be used (defaults to "json", also accepts "csv", "xml", "txt", "md", "html", "tsv", "yaml", and "toml"). |
| boolean | useLocalStorageForData | States if data added/removed should be remembered in local storage (remembered between browser usages, defaults to false). |
| boolean | allowFileImports | States if file importing via drag & drop is enabled (defaults to true). |
| number[] | yearsToHide | States the years that should be hidden (defaults to []). |
| number | dataFetchDelay | States how long the data fetching should wait (in milliseconds) until its next pull (defaults to 60000). |
| boolean | showOnlyDataForYearsAvailable | States if only data for years available is shown (including in the selector, defaults to false). |
| boolean | showHolidaysInDayToolTips | States if the holidays should be shown in the regular day tooltips (defaults to false). |
| boolean | resizable | States if horizontal resizing is enabled (defaults to false). |
| number | startMonth | States the first month in the year that should be displayed (allows an Apr-Mar view, and defaults to 0, for Jan). |
| boolean | allowMultipleFileImports | States if multiple file imports are enabled (defaults to true). |
| number | percentageDecimalPoints | States the number of decimal points to show for percentages (defaults to 2). |
| number | chartsAnimationDelay | States the milliseconds to wait before applying a growth animation to each chart line (for all views, defaults to 50. Set to zero to turn it off). |
| string | exportDateTimeFormat | States the format of the export date/time that is included in some of the formats (defaults to "{dddd}, {d}{o} {mmmm} {yyyy}"). |
| BindingOptionsSideMenu | sideMenu | States the options to use for the side menu (see here for properties). |
| BindingOptionsTitle | title | States the options to use for the title bar (see here for properties). |
| BindingOptionsYearlyStatistics | yearlyStatistics | States the options to use for the yearly statistics area (see here for properties). |
| BindingOptionsDescription | description | States the options to use for the description area (see here for properties). |
| BindingOptionsGuide | guide | States the options to use for the guide area (see here for properties). |
| BindingOptionsTooltip | tooltip | States the options to use for the tooltips (see here for properties). |
| BindingOptionsZooming | zooming | States the options to use for the zooming area (see here for properties). |
| BindingOptionsHoliday[] | holidays | States the options to use for the holidays (defaults to 4 items, see here for properties). |
| BindingOptionsDynamicColorRange | dynamicColorRange | States the options to use for the dynamic color ranges (see here for properties). |
| BindingOptionsColorRange | colorRanges | States the options to use for the color ranges (see here for properties). |