PlotHeatmapOptions (Disconnect Zero: Highcharts API bindings 0.1.0-alpha2 API)

All Superinterfaces:

Any, org.teavm.jso.JSObject

All Known Subinterfaces:

SeriesHeatmapOptions
```
public interface PlotHeatmapOptions
extends Any
```
(Highcharts, Highmaps) A heatmap is a graphical representation of data where the individual values contained in a matrix are represented as colors. Configuration options for the series are given in three levels:
1. Options for all series in a chart are defined in the plotOptions.series object.
2. Options for all heatmap series are defined in plotOptions.heatmap.
3. Options for one single series are given in the series instance array.
(see online documentation for example)
See Also:

https://api.highcharts.com/highcharts/plotOptions.heatmap, https://api.highcharts.com/highmaps/plotOptions.heatmap

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`PlotHeatmapOptions.CompareBase`
`static class`	`PlotHeatmapOptions.GapUnit`
`static interface`	`PlotHeatmapOptions.PointDescriptionFormatter`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getAllAreas()` (Highmaps) Whether all areas of the map defined in `mapData` should be rendered.
`boolean`	`getAllowPointSelect()` (Highcharts, Highmaps) Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
`Unknown`	`getAnimation()` (Highcharts, Highmaps) Animation is disabled by default on the heatmap series.
`double`	`getBoostThreshold()` (Highcharts, Highmaps) Set the point threshold for when a series should enter boost mode.
`String`	`getBorderColor()` (Highmaps, Highcharts) The border color of the map areas.
`double`	`getBorderWidth()` (Highmaps, Highcharts) The border width for each heat map item.
`String`	`getClassName()` (Highcharts, Highmaps) An additional class name to apply to the series' graphical elements.
`boolean`	`getClip()` (Highcharts, Highmaps) Disable this option to allow series rendering in the whole plotting area.
`Unknown`	`getColor()` (Highcharts) The main color of the series.
`boolean`	`getColorAxis()` (Highmaps) Set this option to `false` to prevent a series from connecting to the global color axis.
`double`	`getColorIndex()` (Highcharts, Highmaps) Styled mode only.
`double`	`getColsize()` (Highcharts, Highmaps) The column size - how many X axis units each column in the heatmap should span.
`String`	`getCompare()` (Highstock) Compare the values of the series against the first non-null, non- zero value in the visible range.
`PlotHeatmapOptions.CompareBase`	`getCompareBase()` (Highstock) When compare is `percent`, this option dictates whether to use 0 or 100 as the base of comparison.
`boolean`	`getCompareStart()` (Highstock) Defines if comparison should start from the first point within the visible range or should start from the first point (see online documentation for example) the range.
`PlotHeatmapConnectorsOptions`	`getConnectors()` (Gantt) Override Pathfinder connector options for a series.
`double`	`getCropThreshold()` (Highcharts, Highstock) When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom.
`Unknown`	`getCursor()` (Highcharts, Highmaps) You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
`PlotHeatmapDataGroupingOptions`	`getDataGrouping()` (Highstock) Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.
`PlotHeatmapDataLabelsOptions`	`getDataLabels()` (Highcharts, Highmaps) Options for the series data labels, appearing next to each data point.
`String`	`getDescription()` (Highcharts, Highmaps) Requires the Accessibility module.
`PlotHeatmapDragDropOptions`	`getDragDrop()` (Highcharts, Highmaps) The draggable-points module allows points to be moved around or modified in the chart.
`boolean`	`getEnableMouseTracking()` (Highcharts, Highmaps) Enable or disable the mouse tracking for a specific series.
`PlotHeatmapEventsOptions`	`getEvents()` (Highcharts, Highmaps) General event handlers for the series items.
`boolean`	`getExposeElementToA11y()` (Highcharts, Highmaps) By default, series are exposed to screen readers as regions.
`double`	`getGapSize()` (Highstock) Defines when to display a gap in the graph, together with the gapUnit option.
`PlotHeatmapOptions.GapUnit`	`getGapUnit()` (Highstock) Together with gapSize, this option defines where to draw gaps in the graph.
`Unknown`	`getJoinBy()` (Highmaps) What property to join the `mapData` to the value data.
`String[]`	`getKeys()` (Highcharts, Highmaps) An array specifying which option maps to which key in the data point array.
`PlotHeatmapLabelOptions`	`getLabel()` (Highcharts, Highstock, Gantt) Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series.
`String`	`getLinkedTo()` (Highcharts, Highstock, Gantt) The id of another series to link to.
`PlotSeriesOptions`	`getNavigatorOptions()` (Highstock) Options for the corresponding navigator series if `showInNavigator` is `true` for this series.
`Unknown`	`getNegativeColor()` (Highcharts, Highmaps) The color for the parts of the graph or points that are below the threshold.
`String`	`getNullColor()` (Highcharts, Highmaps) The color applied to null points.
`PlotHeatmapPointOptions`	`getPoint()` (Highcharts, Highmaps) Properties for each single point.
`PlotHeatmapOptions.PointDescriptionFormatter`	`getPointDescriptionFormatter()` (Highcharts, Highmaps) Same as accessibility.pointDescriptionFormatter, but for an individual series.
`double`	`getPointPadding()` (Highcharts, Highmaps) Padding between the points in the heatmap.
`double`	`getRowsize()` (Highcharts, Highmaps) The row size - how many Y axis units each heatmap row should span.
`boolean`	`getSelected()` (Highcharts, Highmaps) Whether to select the series initially.
`boolean`	`getShowCheckbox()` (Highcharts, Highmaps) If true, a checkbox is displayed next to the legend item to allow selecting the series.
`boolean`	`getShowInLegend()` (Highcharts, Highmaps) Whether to display this particular series or series type in the legend.
`boolean`	`getShowInNavigator()` (Highstock) Whether or not to show the series in the navigator.
`boolean`	`getSkipKeyboardNavigation()` (Highcharts, Highmaps) If set to `true`, the accessibility module will skip past the points in this series for keyboard navigation.
`PlotHeatmapStatesOptions`	`getStates()` (Highcharts, Highmaps) A wrapper object for all the series options in specific states.
`boolean`	`getStickyTracking()` (Highcharts, Highstock) Sticky tracking of mouse events.
`PlotHeatmapTooltipOptions`	`getTooltip()` (Highcharts, Highstock) A configuration object for the tooltip rendering of each single series.
`double`	`getTurboThreshold()` (Highcharts, Highstock, Gantt) When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.
`boolean`	`getVisible()` (Highcharts, Highmaps) Set the initial visibility of the series.
`double`	`getZIndex()` (Highmaps) Define the z index of the series.
`String`	`getZoneAxis()` (Highcharts, Highstock) Defines the Axis on which the zones are applied.
`Array<PlotHeatmapZonesOptions>`	`getZones()` (Highcharts, Highstock) An array defining zones within a series.
`void`	`setAllAreas(boolean value)` (Highmaps) Whether all areas of the map defined in `mapData` should be rendered.
`void`	`setAllowPointSelect(boolean value)` (Highcharts, Highmaps) Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
`void`	`setAnimation(boolean value)` (Highcharts, Highmaps) Animation is disabled by default on the heatmap series.
`void`	`setAnimation(PlotHeatmapAnimationOptions value)` (Highcharts, Highmaps) Animation is disabled by default on the heatmap series.
`void`	`setBoostThreshold(double value)` (Highcharts, Highmaps) Set the point threshold for when a series should enter boost mode.
`void`	`setBorderColor(String value)` (Highmaps, Highcharts) The border color of the map areas.
`void`	`setBorderWidth(double value)` (Highmaps, Highcharts) The border width for each heat map item.
`void`	`setClassName(String value)` (Highcharts, Highmaps) An additional class name to apply to the series' graphical elements.
`void`	`setClip(boolean value)` (Highcharts, Highmaps) Disable this option to allow series rendering in the whole plotting area.
`void`	`setColor(Any value)` (Highcharts) The main color of the series.
`void`	`setColor(GradientColorObject value)` (Highcharts) The main color of the series.
`void`	`setColor(String value)` (Highcharts) The main color of the series.
`void`	`setColorAxis(boolean value)` (Highmaps) Set this option to `false` to prevent a series from connecting to the global color axis.
`void`	`setColorIndex(double value)` (Highcharts, Highmaps) Styled mode only.
`void`	`setColsize(double value)` (Highcharts, Highmaps) The column size - how many X axis units each column in the heatmap should span.
`void`	`setCompare(String value)` (Highstock) Compare the values of the series against the first non-null, non- zero value in the visible range.
`void`	`setCompareBase(PlotHeatmapOptions.CompareBase value)` (Highstock) When compare is `percent`, this option dictates whether to use 0 or 100 as the base of comparison.
`void`	`setCompareStart(boolean value)` (Highstock) Defines if comparison should start from the first point within the visible range or should start from the first point (see online documentation for example) the range.
`void`	`setConnectors(PlotHeatmapConnectorsOptions value)` (Gantt) Override Pathfinder connector options for a series.
`void`	`setCropThreshold(double value)` (Highcharts, Highstock) When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom.
`void`	`setCursor(CursorType value)` (Highcharts, Highmaps) You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
`void`	`setCursor(String value)` (Highcharts, Highmaps) You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
`void`	`setDataGrouping(PlotHeatmapDataGroupingOptions value)` (Highstock) Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.
`void`	`setDataLabels(PlotHeatmapDataLabelsOptions value)` (Highcharts, Highmaps) Options for the series data labels, appearing next to each data point.
`void`	`setDescription(String value)` (Highcharts, Highmaps) Requires the Accessibility module.
`void`	`setDragDrop(PlotHeatmapDragDropOptions value)` (Highcharts, Highmaps) The draggable-points module allows points to be moved around or modified in the chart.
`void`	`setEnableMouseTracking(boolean value)` (Highcharts, Highmaps) Enable or disable the mouse tracking for a specific series.
`void`	`setEvents(PlotHeatmapEventsOptions value)` (Highcharts, Highmaps) General event handlers for the series items.
`void`	`setExposeElementToA11y(boolean value)` (Highcharts, Highmaps) By default, series are exposed to screen readers as regions.
`void`	`setGapSize(double value)` (Highstock) Defines when to display a gap in the graph, together with the gapUnit option.
`void`	`setGapUnit(PlotHeatmapOptions.GapUnit value)` (Highstock) Together with gapSize, this option defines where to draw gaps in the graph.
`void`	`setJoinBy(String value)` (Highmaps) What property to join the `mapData` to the value data.
`void`	`setJoinBy(String[] value)` (Highmaps) What property to join the `mapData` to the value data.
`void`	`setKeys(String[] value)` (Highcharts, Highmaps) An array specifying which option maps to which key in the data point array.
`void`	`setLabel(PlotHeatmapLabelOptions value)` (Highcharts, Highstock, Gantt) Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series.
`void`	`setLinkedTo(String value)` (Highcharts, Highstock, Gantt) The id of another series to link to.
`void`	`setNavigatorOptions(PlotSeriesOptions value)` (Highstock) Options for the corresponding navigator series if `showInNavigator` is `true` for this series.
`void`	`setNegativeColor(Any value)` (Highcharts, Highmaps) The color for the parts of the graph or points that are below the threshold.
`void`	`setNegativeColor(GradientColorObject value)` (Highcharts, Highmaps) The color for the parts of the graph or points that are below the threshold.
`void`	`setNegativeColor(String value)` (Highcharts, Highmaps) The color for the parts of the graph or points that are below the threshold.
`void`	`setNullColor(String value)` (Highcharts, Highmaps) The color applied to null points.
`void`	`setPoint(PlotHeatmapPointOptions value)` (Highcharts, Highmaps) Properties for each single point.
`void`	`setPointDescriptionFormatter(PlotHeatmapOptions.PointDescriptionFormatter value)` (Highcharts, Highmaps) Same as accessibility.pointDescriptionFormatter, but for an individual series.
`void`	`setPointPadding(double value)` (Highcharts, Highmaps) Padding between the points in the heatmap.
`void`	`setRowsize(double value)` (Highcharts, Highmaps) The row size - how many Y axis units each heatmap row should span.
`void`	`setSelected(boolean value)` (Highcharts, Highmaps) Whether to select the series initially.
`void`	`setShowCheckbox(boolean value)` (Highcharts, Highmaps) If true, a checkbox is displayed next to the legend item to allow selecting the series.
`void`	`setShowInLegend(boolean value)` (Highcharts, Highmaps) Whether to display this particular series or series type in the legend.
`void`	`setShowInNavigator(boolean value)` (Highstock) Whether or not to show the series in the navigator.
`void`	`setSkipKeyboardNavigation(boolean value)` (Highcharts, Highmaps) If set to `true`, the accessibility module will skip past the points in this series for keyboard navigation.
`void`	`setStates(PlotHeatmapStatesOptions value)` (Highcharts, Highmaps) A wrapper object for all the series options in specific states.
`void`	`setStickyTracking(boolean value)` (Highcharts, Highstock) Sticky tracking of mouse events.
`void`	`setTooltip(PlotHeatmapTooltipOptions value)` (Highcharts, Highstock) A configuration object for the tooltip rendering of each single series.
`void`	`setTurboThreshold(double value)` (Highcharts, Highstock, Gantt) When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.
`void`	`setVisible(boolean value)` (Highcharts, Highmaps) Set the initial visibility of the series.
`void`	`setZIndex(double value)` (Highmaps) Define the z index of the series.
`void`	`setZoneAxis(String value)` (Highcharts, Highstock) Defines the Axis on which the zones are applied.
`void`	`setZones(Array<PlotHeatmapZonesOptions> value)` (Highcharts, Highstock) An array defining zones within a series.

Methods inherited from interface js.lang.Any
empty

Methods inherited from interface org.teavm.jso.JSObject
cast

- Method Detail
  - getAllAreas
```
boolean getAllAreas()
```
    (Highmaps) Whether all areas of the map defined in mapData should be rendered. If true, areas which don't correspond to a data point, are rendered as null points. If false, those areas are skipped.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.allAreas
  - setAllAreas
```
void setAllAreas(boolean value)
```
    (Highmaps) Whether all areas of the map defined in mapData should be rendered. If true, areas which don't correspond to a data point, are rendered as null points. If false, those areas are skipped.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.allAreas
  - getAllowPointSelect
```
boolean getAllowPointSelect()
```
    (Highcharts, Highmaps) Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.allowPointSelect, https://api.highcharts.com/highmaps/plotOptions.heatmap.allowPointSelect
  - setAllowPointSelect
```
void setAllowPointSelect(boolean value)
```
    (Highcharts, Highmaps) Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.allowPointSelect, https://api.highcharts.com/highmaps/plotOptions.heatmap.allowPointSelect
  - getAnimation
```
@Nullable
Unknown getAnimation()
```
    (Highcharts, Highmaps) Animation is disabled by default on the heatmap series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.animation, https://api.highcharts.com/highmaps/plotOptions.heatmap.animation
  - setAnimation
```
void setAnimation(boolean value)
```
    (Highcharts, Highmaps) Animation is disabled by default on the heatmap series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.animation, https://api.highcharts.com/highmaps/plotOptions.heatmap.animation
  - setAnimation
```
void setAnimation(PlotHeatmapAnimationOptions value)
```
    (Highcharts, Highmaps) Animation is disabled by default on the heatmap series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.animation, https://api.highcharts.com/highmaps/plotOptions.heatmap.animation
  - getBoostThreshold
```
double getBoostThreshold()
```
    (Highcharts, Highmaps) Set the point threshold for when a series should enter boost mode. Setting it to e.g. 2000 will cause the series to enter boost mode when there are 2000 or more points in the series. To disable boosting on the series, set the boostThreshold to 0. Setting it to 1 will force boosting. Note that the cropThreshold also affects this setting. When zooming in on a series that has fewer points than the cropThreshold, all points are rendered although outside the visible plot area, and the boostThreshold won't take effect. Requires modules/boost.js.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.boostThreshold, https://api.highcharts.com/highmaps/plotOptions.heatmap.boostThreshold
  - setBoostThreshold
```
void setBoostThreshold(double value)
```
    (Highcharts, Highmaps) Set the point threshold for when a series should enter boost mode. Setting it to e.g. 2000 will cause the series to enter boost mode when there are 2000 or more points in the series. To disable boosting on the series, set the boostThreshold to 0. Setting it to 1 will force boosting. Note that the cropThreshold also affects this setting. When zooming in on a series that has fewer points than the cropThreshold, all points are rendered although outside the visible plot area, and the boostThreshold won't take effect. Requires modules/boost.js.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.boostThreshold, https://api.highcharts.com/highmaps/plotOptions.heatmap.boostThreshold
  - getBorderColor
```
@Nullable
String getBorderColor()
```
    (Highmaps, Highcharts) The border color of the map areas. In styled mode, the border stroke is given in the .highcharts-point class.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.borderColor, https://api.highcharts.com/highcharts/plotOptions.heatmap.borderColor
  - setBorderColor
```
void setBorderColor(String value)
```
    (Highmaps, Highcharts) The border color of the map areas. In styled mode, the border stroke is given in the .highcharts-point class.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.borderColor, https://api.highcharts.com/highcharts/plotOptions.heatmap.borderColor
  - getBorderWidth
```
double getBorderWidth()
```
    (Highmaps, Highcharts) The border width for each heat map item.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.borderWidth, https://api.highcharts.com/highcharts/plotOptions.heatmap.borderWidth
  - setBorderWidth
```
void setBorderWidth(double value)
```
    (Highmaps, Highcharts) The border width for each heat map item.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.borderWidth, https://api.highcharts.com/highcharts/plotOptions.heatmap.borderWidth
  - getClassName
```
@Nullable
String getClassName()
```
    (Highcharts, Highmaps) An additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.className, https://api.highcharts.com/highmaps/plotOptions.heatmap.className
  - setClassName
```
void setClassName(String value)
```
    (Highcharts, Highmaps) An additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.className, https://api.highcharts.com/highmaps/plotOptions.heatmap.className
  - getClip
```
boolean getClip()
```
    (Highcharts, Highmaps) Disable this option to allow series rendering in the whole plotting area. Note: Clipping should be always enabled when chart.zoomType is set
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.clip, https://api.highcharts.com/highmaps/plotOptions.heatmap.clip
  - setClip
```
void setClip(boolean value)
```
    (Highcharts, Highmaps) Disable this option to allow series rendering in the whole plotting area. Note: Clipping should be always enabled when chart.zoomType is set
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.clip, https://api.highcharts.com/highmaps/plotOptions.heatmap.clip
  - getColor
```
@Nullable
Unknown getColor()
```
    (Highcharts) The main color of the series. In heat maps this color is rarely used, as we mostly use the color to denote the value of each point. Unless options are set in the colorAxis, the default value is pulled from the options.colors array.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.color
  - setColor
```
void setColor(GradientColorObject value)
```
    (Highcharts) The main color of the series. In heat maps this color is rarely used, as we mostly use the color to denote the value of each point. Unless options are set in the colorAxis, the default value is pulled from the options.colors array.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.color
  - setColor
```
void setColor(String value)
```
    (Highcharts) The main color of the series. In heat maps this color is rarely used, as we mostly use the color to denote the value of each point. Unless options are set in the colorAxis, the default value is pulled from the options.colors array.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.color
  - setColor
```
void setColor(Any value)
```
    (Highcharts) The main color of the series. In heat maps this color is rarely used, as we mostly use the color to denote the value of each point. Unless options are set in the colorAxis, the default value is pulled from the options.colors array.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.color
  - getColorAxis
```
boolean getColorAxis()
```
    (Highmaps) Set this option to false to prevent a series from connecting to the global color axis. This will cause the series to have its own legend item.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.colorAxis
  - setColorAxis
```
void setColorAxis(boolean value)
```
    (Highmaps) Set this option to false to prevent a series from connecting to the global color axis. This will cause the series to have its own legend item.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.colorAxis
  - getColorIndex
```
double getColorIndex()
```
    (Highcharts, Highmaps) Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.colorIndex, https://api.highcharts.com/highmaps/plotOptions.heatmap.colorIndex
  - setColorIndex
```
void setColorIndex(double value)
```
    (Highcharts, Highmaps) Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.colorIndex, https://api.highcharts.com/highmaps/plotOptions.heatmap.colorIndex
  - getColsize
```
double getColsize()
```
    (Highcharts, Highmaps) The column size - how many X axis units each column in the heatmap should span.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.colsize, https://api.highcharts.com/highmaps/plotOptions.heatmap.colsize
  - setColsize
```
void setColsize(double value)
```
    (Highcharts, Highmaps) The column size - how many X axis units each column in the heatmap should span.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.colsize, https://api.highcharts.com/highmaps/plotOptions.heatmap.colsize
  - getCompare
```
@Nullable
String getCompare()
```
    (Highstock) Compare the values of the series against the first non-null, non- zero value in the visible range. The y axis will show percentage or absolute change depending on whether compare is set to "percent" or "value". When this is applied to multiple series, it allows comparing the development of the series against each other. Adds a change field to every point object.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.compare
  - setCompare
```
void setCompare(String value)
```
    (Highstock) Compare the values of the series against the first non-null, non- zero value in the visible range. The y axis will show percentage or absolute change depending on whether compare is set to "percent" or "value". When this is applied to multiple series, it allows comparing the development of the series against each other. Adds a change field to every point object.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.compare
  - getCompareBase
```
@Nullable
PlotHeatmapOptions.CompareBase getCompareBase()
```
    (Highstock) When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.compareBase
  - setCompareBase
```
void setCompareBase(PlotHeatmapOptions.CompareBase value)
```
    (Highstock) When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.compareBase
  - getCompareStart
```
boolean getCompareStart()
```
    (Highstock) Defines if comparison should start from the first point within the visible range or should start from the first point (see online documentation for example) the range. In other words, this flag determines if first point within the visible range will have 0% (compareStart=true) or should have been already calculated according to the previous point (compareStart=false).
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.compareStart
  - setCompareStart
```
void setCompareStart(boolean value)
```
    (Highstock) Defines if comparison should start from the first point within the visible range or should start from the first point (see online documentation for example) the range. In other words, this flag determines if first point within the visible range will have 0% (compareStart=true) or should have been already calculated according to the previous point (compareStart=false).
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.compareStart
  - getConnectors
```
@Nullable
PlotHeatmapConnectorsOptions getConnectors()
```
    (Gantt) Override Pathfinder connector options for a series. Requires Highcharts Gantt to be loaded.
    
    See Also:
    
    https://api.highcharts.com/gantt/plotOptions.heatmap.connectors
  - setConnectors
```
void setConnectors(PlotHeatmapConnectorsOptions value)
```
    (Gantt) Override Pathfinder connector options for a series. Requires Highcharts Gantt to be loaded.
    
    See Also:
    
    https://api.highcharts.com/gantt/plotOptions.heatmap.connectors
  - getCropThreshold
```
double getCropThreshold()
```
    (Highcharts, Highstock) When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.cropThreshold, https://api.highcharts.com/highstock/plotOptions.heatmap.cropThreshold
  - setCropThreshold
```
void setCropThreshold(double value)
```
    (Highcharts, Highstock) When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.cropThreshold, https://api.highcharts.com/highstock/plotOptions.heatmap.cropThreshold
  - getCursor
```
@Nullable
Unknown getCursor()
```
    (Highcharts, Highmaps) You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. In styled mode, the series cursor can be set with the same classes as listed under series.color.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.cursor, https://api.highcharts.com/highmaps/plotOptions.heatmap.cursor
  - setCursor
```
void setCursor(CursorType value)
```
    (Highcharts, Highmaps) You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. In styled mode, the series cursor can be set with the same classes as listed under series.color.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.cursor, https://api.highcharts.com/highmaps/plotOptions.heatmap.cursor
  - setCursor
```
void setCursor(String value)
```
    (Highcharts, Highmaps) You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. In styled mode, the series cursor can be set with the same classes as listed under series.color.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.cursor, https://api.highcharts.com/highmaps/plotOptions.heatmap.cursor
  - getDataGrouping
```
@Nullable
PlotHeatmapDataGroupingOptions getDataGrouping()
```
    (Highstock) Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. Highstock by default applies data grouping when the points become closer than a certain pixel value, determined by the groupPixelWidth option. If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup. If point options other than the data itself are set, for example name or color or custom properties, the grouping logic doesn't know how to group it. In this case the options of the first point instance are copied over to the group point. This can be altered through a custom approximation callback function.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.dataGrouping
  - setDataGrouping
```
void setDataGrouping(PlotHeatmapDataGroupingOptions value)
```
    (Highstock) Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. Highstock by default applies data grouping when the points become closer than a certain pixel value, determined by the groupPixelWidth option. If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup. If point options other than the data itself are set, for example name or color or custom properties, the grouping logic doesn't know how to group it. In this case the options of the first point instance are copied over to the group point. This can be altered through a custom approximation callback function.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.dataGrouping
  - getDataLabels
```
@Nullable
PlotHeatmapDataLabelsOptions getDataLabels()
```
    (Highcharts, Highmaps) Options for the series data labels, appearing next to each data point. Since v6.2.0, multiple data labels can be applied to each single point by defining them as an array of configs. In styled mode, the data labels can be styled with the .highcharts-data-label-box and .highcharts-data-label class names (see example).
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.dataLabels, https://api.highcharts.com/highmaps/plotOptions.heatmap.dataLabels
  - setDataLabels
```
void setDataLabels(PlotHeatmapDataLabelsOptions value)
```
    (Highcharts, Highmaps) Options for the series data labels, appearing next to each data point. Since v6.2.0, multiple data labels can be applied to each single point by defining them as an array of configs. In styled mode, the data labels can be styled with the .highcharts-data-label-box and .highcharts-data-label class names (see example).
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.dataLabels, https://api.highcharts.com/highmaps/plotOptions.heatmap.dataLabels
  - getDescription
```
@Nullable
String getDescription()
```
    (Highcharts, Highmaps) Requires the Accessibility module. A description of the series to add to the screen reader information about the series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.description, https://api.highcharts.com/highmaps/plotOptions.heatmap.description
  - setDescription
```
void setDescription(String value)
```
    (Highcharts, Highmaps) Requires the Accessibility module. A description of the series to add to the screen reader information about the series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.description, https://api.highcharts.com/highmaps/plotOptions.heatmap.description
  - getDragDrop
```
@Nullable
PlotHeatmapDragDropOptions getDragDrop()
```
    (Highcharts, Highmaps) The draggable-points module allows points to be moved around or modified in the chart. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop. It requires the modules/draggable-points.js file to be loaded.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.dragDrop, https://api.highcharts.com/highmaps/plotOptions.heatmap.dragDrop
  - setDragDrop
```
void setDragDrop(PlotHeatmapDragDropOptions value)
```
    (Highcharts, Highmaps) The draggable-points module allows points to be moved around or modified in the chart. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop. It requires the modules/draggable-points.js file to be loaded.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.dragDrop, https://api.highcharts.com/highmaps/plotOptions.heatmap.dragDrop
  - getEnableMouseTracking
```
boolean getEnableMouseTracking()
```
    (Highcharts, Highmaps) Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.enableMouseTracking, https://api.highcharts.com/highmaps/plotOptions.heatmap.enableMouseTracking
  - setEnableMouseTracking
```
void setEnableMouseTracking(boolean value)
```
    (Highcharts, Highmaps) Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.enableMouseTracking, https://api.highcharts.com/highmaps/plotOptions.heatmap.enableMouseTracking
  - getEvents
```
@Nullable
PlotHeatmapEventsOptions getEvents()
```
    (Highcharts, Highmaps) General event handlers for the series items. These event hooks can also be attached to the series at run time using the Highcharts.addEvent function.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.events, https://api.highcharts.com/highmaps/plotOptions.heatmap.events
  - setEvents
```
void setEvents(PlotHeatmapEventsOptions value)
```
    (Highcharts, Highmaps) General event handlers for the series items. These event hooks can also be attached to the series at run time using the Highcharts.addEvent function.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.events, https://api.highcharts.com/highmaps/plotOptions.heatmap.events
  - getExposeElementToA11y
```
boolean getExposeElementToA11y()
```
    (Highcharts, Highmaps) By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series. Requires the Accessibility module.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.exposeElementToA11y, https://api.highcharts.com/highmaps/plotOptions.heatmap.exposeElementToA11y
  - setExposeElementToA11y
```
void setExposeElementToA11y(boolean value)
```
    (Highcharts, Highmaps) By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series. Requires the Accessibility module.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.exposeElementToA11y, https://api.highcharts.com/highmaps/plotOptions.heatmap.exposeElementToA11y
  - getGapSize
```
double getGapSize()
```
    (Highstock) Defines when to display a gap in the graph, together with the gapUnit option. In case when dataGrouping is enabled, points can be grouped into a larger time span. This can make the grouped points to have a greater distance than the absolute value of gapSize property, which will result in disappearing graph completely. To prevent this situation the mentioned distance between grouped points is used instead of previously defined gapSize. In practice, this option is most often used to visualize gaps in time series. In a stock chart, intraday data is available for daytime hours, while gaps will appear in nights and weekends.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.gapSize
  - setGapSize
```
void setGapSize(double value)
```
    (Highstock) Defines when to display a gap in the graph, together with the gapUnit option. In case when dataGrouping is enabled, points can be grouped into a larger time span. This can make the grouped points to have a greater distance than the absolute value of gapSize property, which will result in disappearing graph completely. To prevent this situation the mentioned distance between grouped points is used instead of previously defined gapSize. In practice, this option is most often used to visualize gaps in time series. In a stock chart, intraday data is available for daytime hours, while gaps will appear in nights and weekends.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.gapSize
  - getGapUnit
```
@Nullable
PlotHeatmapOptions.GapUnit getGapUnit()
```
    (Highstock) Together with gapSize, this option defines where to draw gaps in the graph. When the gapUnit is relative (default), a gap size of 5 means that if the distance between two points is greater than five times that of the two closest points, the graph will be broken. When the gapUnit is value, the gap is based on absolute axis values, which on a datetime axis is milliseconds. This also applies to the navigator series that inherits gap options from the base series.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.gapUnit
  - setGapUnit
```
void setGapUnit(PlotHeatmapOptions.GapUnit value)
```
    (Highstock) Together with gapSize, this option defines where to draw gaps in the graph. When the gapUnit is relative (default), a gap size of 5 means that if the distance between two points is greater than five times that of the two closest points, the graph will be broken. When the gapUnit is value, the gap is based on absolute axis values, which on a datetime axis is milliseconds. This also applies to the navigator series that inherits gap options from the base series.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.gapUnit
  - getJoinBy
```
@Nullable
Unknown getJoinBy()
```
    (Highmaps) What property to join the mapData to the value data. For example, if joinBy is "code", the mapData items with a specific code is merged into the data with the same code. For maps loaded from GeoJSON, the keys may be held in each point's properties object. The joinBy option can also be an array of two values, where the first points to a key in the mapData, and the second points to another key in the data. When joinBy is null, the map items are joined by their position in the array, which performs much better in maps with many data points. This is the recommended option if you are printing more than a thousand data points and have a backend that can preprocess the data into a parallel array of the mapData.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.joinBy
  - setJoinBy
```
void setJoinBy(String value)
```
    (Highmaps) What property to join the mapData to the value data. For example, if joinBy is "code", the mapData items with a specific code is merged into the data with the same code. For maps loaded from GeoJSON, the keys may be held in each point's properties object. The joinBy option can also be an array of two values, where the first points to a key in the mapData, and the second points to another key in the data. When joinBy is null, the map items are joined by their position in the array, which performs much better in maps with many data points. This is the recommended option if you are printing more than a thousand data points and have a backend that can preprocess the data into a parallel array of the mapData.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.joinBy
  - setJoinBy
```
void setJoinBy(String[] value)
```
    (Highmaps) What property to join the mapData to the value data. For example, if joinBy is "code", the mapData items with a specific code is merged into the data with the same code. For maps loaded from GeoJSON, the keys may be held in each point's properties object. The joinBy option can also be an array of two values, where the first points to a key in the mapData, and the second points to another key in the data. When joinBy is null, the map items are joined by their position in the array, which performs much better in maps with many data points. This is the recommended option if you are printing more than a thousand data points and have a backend that can preprocess the data into a parallel array of the mapData.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.joinBy
  - getKeys
```
@Nullable
String[] getKeys()
```
    (Highcharts, Highmaps) An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.keys, https://api.highcharts.com/highmaps/plotOptions.heatmap.keys
  - setKeys
```
void setKeys(String[] value)
```
    (Highcharts, Highmaps) An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.keys, https://api.highcharts.com/highmaps/plotOptions.heatmap.keys
  - getLabel
```
@Nullable
PlotHeatmapLabelOptions getLabel()
```
    (Highcharts, Highstock, Gantt) Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position. The series labels currently work with series types having a graph or an area. Requires the series-label.js module.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.label, https://api.highcharts.com/highstock/plotOptions.heatmap.label, https://api.highcharts.com/gantt/plotOptions.heatmap.label
  - setLabel
```
void setLabel(PlotHeatmapLabelOptions value)
```
    (Highcharts, Highstock, Gantt) Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position. The series labels currently work with series types having a graph or an area. Requires the series-label.js module.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.label, https://api.highcharts.com/highstock/plotOptions.heatmap.label, https://api.highcharts.com/gantt/plotOptions.heatmap.label
  - getLinkedTo
```
@Nullable
String getLinkedTo()
```
    (Highcharts, Highstock, Gantt) The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.linkedTo, https://api.highcharts.com/highstock/plotOptions.heatmap.linkedTo, https://api.highcharts.com/gantt/plotOptions.heatmap.linkedTo
  - setLinkedTo
```
void setLinkedTo(String value)
```
    (Highcharts, Highstock, Gantt) The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.linkedTo, https://api.highcharts.com/highstock/plotOptions.heatmap.linkedTo, https://api.highcharts.com/gantt/plotOptions.heatmap.linkedTo
  - getNavigatorOptions
```
@Nullable
PlotSeriesOptions getNavigatorOptions()
```
    (Highstock) Options for the corresponding navigator series if showInNavigator is true for this series. Available options are the same as any series, documented at plotOptions and series. These options are merged with options in navigator.series, and will take precedence if the same option is defined both places.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.navigatorOptions
  - setNavigatorOptions
```
void setNavigatorOptions(PlotSeriesOptions value)
```
    (Highstock) Options for the corresponding navigator series if showInNavigator is true for this series. Available options are the same as any series, documented at plotOptions and series. These options are merged with options in navigator.series, and will take precedence if the same option is defined both places.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.navigatorOptions
  - getNegativeColor
```
@Nullable
Unknown getNegativeColor()
```
    (Highcharts, Highmaps) The color for the parts of the graph or points that are below the threshold.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.negativeColor, https://api.highcharts.com/highmaps/plotOptions.heatmap.negativeColor
  - setNegativeColor
```
void setNegativeColor(GradientColorObject value)
```
    (Highcharts, Highmaps) The color for the parts of the graph or points that are below the threshold.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.negativeColor, https://api.highcharts.com/highmaps/plotOptions.heatmap.negativeColor
  - setNegativeColor
```
void setNegativeColor(String value)
```
    (Highcharts, Highmaps) The color for the parts of the graph or points that are below the threshold.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.negativeColor, https://api.highcharts.com/highmaps/plotOptions.heatmap.negativeColor
  - setNegativeColor
```
void setNegativeColor(Any value)
```
    (Highcharts, Highmaps) The color for the parts of the graph or points that are below the threshold.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.negativeColor, https://api.highcharts.com/highmaps/plotOptions.heatmap.negativeColor
  - getNullColor
```
@Nullable
String getNullColor()
```
    (Highcharts, Highmaps) The color applied to null points. In styled mode, a general CSS class is applied instead.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.nullColor, https://api.highcharts.com/highmaps/plotOptions.heatmap.nullColor
  - setNullColor
```
void setNullColor(String value)
```
    (Highcharts, Highmaps) The color applied to null points. In styled mode, a general CSS class is applied instead.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.nullColor, https://api.highcharts.com/highmaps/plotOptions.heatmap.nullColor
  - getPoint
```
@Nullable
PlotHeatmapPointOptions getPoint()
```
    (Highcharts, Highmaps) Properties for each single point.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.point, https://api.highcharts.com/highmaps/plotOptions.heatmap.point
  - setPoint
```
void setPoint(PlotHeatmapPointOptions value)
```
    (Highcharts, Highmaps) Properties for each single point.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.point, https://api.highcharts.com/highmaps/plotOptions.heatmap.point
  - getPointDescriptionFormatter
```
@Nullable
PlotHeatmapOptions.PointDescriptionFormatter getPointDescriptionFormatter()
```
    (Highcharts, Highmaps) Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.pointDescriptionFormatter, https://api.highcharts.com/highmaps/plotOptions.heatmap.pointDescriptionFormatter
  - setPointDescriptionFormatter
```
void setPointDescriptionFormatter(PlotHeatmapOptions.PointDescriptionFormatter value)
```
    (Highcharts, Highmaps) Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.pointDescriptionFormatter, https://api.highcharts.com/highmaps/plotOptions.heatmap.pointDescriptionFormatter
  - getPointPadding
```
double getPointPadding()
```
    (Highcharts, Highmaps) Padding between the points in the heatmap.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.pointPadding, https://api.highcharts.com/highmaps/plotOptions.heatmap.pointPadding
  - setPointPadding
```
void setPointPadding(double value)
```
    (Highcharts, Highmaps) Padding between the points in the heatmap.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.pointPadding, https://api.highcharts.com/highmaps/plotOptions.heatmap.pointPadding
  - getRowsize
```
double getRowsize()
```
    (Highcharts, Highmaps) The row size - how many Y axis units each heatmap row should span.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.rowsize, https://api.highcharts.com/highmaps/plotOptions.heatmap.rowsize
  - setRowsize
```
void setRowsize(double value)
```
    (Highcharts, Highmaps) The row size - how many Y axis units each heatmap row should span.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.rowsize, https://api.highcharts.com/highmaps/plotOptions.heatmap.rowsize
  - getSelected
```
boolean getSelected()
```
    (Highcharts, Highmaps) Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.selected, https://api.highcharts.com/highmaps/plotOptions.heatmap.selected
  - setSelected
```
void setSelected(boolean value)
```
    (Highcharts, Highmaps) Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.selected, https://api.highcharts.com/highmaps/plotOptions.heatmap.selected
  - getShowCheckbox
```
boolean getShowCheckbox()
```
    (Highcharts, Highmaps) If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.showCheckbox, https://api.highcharts.com/highmaps/plotOptions.heatmap.showCheckbox
  - setShowCheckbox
```
void setShowCheckbox(boolean value)
```
    (Highcharts, Highmaps) If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.showCheckbox, https://api.highcharts.com/highmaps/plotOptions.heatmap.showCheckbox
  - getShowInLegend
```
boolean getShowInLegend()
```
    (Highcharts, Highmaps) Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.showInLegend, https://api.highcharts.com/highmaps/plotOptions.heatmap.showInLegend
  - setShowInLegend
```
void setShowInLegend(boolean value)
```
    (Highcharts, Highmaps) Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.showInLegend, https://api.highcharts.com/highmaps/plotOptions.heatmap.showInLegend
  - getShowInNavigator
```
boolean getShowInNavigator()
```
    (Highstock) Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.showInNavigator
  - setShowInNavigator
```
void setShowInNavigator(boolean value)
```
    (Highstock) Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.
    
    See Also:
    
    https://api.highcharts.com/highstock/plotOptions.heatmap.showInNavigator
  - getSkipKeyboardNavigation
```
boolean getSkipKeyboardNavigation()
```
    (Highcharts, Highmaps) If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.skipKeyboardNavigation, https://api.highcharts.com/highmaps/plotOptions.heatmap.skipKeyboardNavigation
  - setSkipKeyboardNavigation
```
void setSkipKeyboardNavigation(boolean value)
```
    (Highcharts, Highmaps) If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.skipKeyboardNavigation, https://api.highcharts.com/highmaps/plotOptions.heatmap.skipKeyboardNavigation
  - getStates
```
@Nullable
PlotHeatmapStatesOptions getStates()
```
    (Highcharts, Highmaps) A wrapper object for all the series options in specific states.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.states, https://api.highcharts.com/highmaps/plotOptions.heatmap.states
  - setStates
```
void setStates(PlotHeatmapStatesOptions value)
```
    (Highcharts, Highmaps) A wrapper object for all the series options in specific states.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.states, https://api.highcharts.com/highmaps/plotOptions.heatmap.states
  - getStickyTracking
```
boolean getStickyTracking()
```
    (Highcharts, Highstock) Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.stickyTracking, https://api.highcharts.com/highstock/plotOptions.heatmap.stickyTracking
  - setStickyTracking
```
void setStickyTracking(boolean value)
```
    (Highcharts, Highstock) Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.stickyTracking, https://api.highcharts.com/highstock/plotOptions.heatmap.stickyTracking
  - getTooltip
```
@Nullable
PlotHeatmapTooltipOptions getTooltip()
```
    (Highcharts, Highstock) A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip. Overridable properties are headerFormat, pointFormat, yDecimals, xDateFormat, yPrefix and ySuffix. Unlike other series, in a scatter plot the series.name by default shows in the headerFormat and point.x and point.y in the pointFormat.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.tooltip, https://api.highcharts.com/highstock/plotOptions.heatmap.tooltip
  - setTooltip
```
void setTooltip(PlotHeatmapTooltipOptions value)
```
    (Highcharts, Highstock) A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip. Overridable properties are headerFormat, pointFormat, yDecimals, xDateFormat, yPrefix and ySuffix. Unlike other series, in a scatter plot the series.name by default shows in the headerFormat and point.x and point.y in the pointFormat.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.tooltip, https://api.highcharts.com/highstock/plotOptions.heatmap.tooltip
  - getTurboThreshold
```
double getTurboThreshold()
```
    (Highcharts, Highstock, Gantt) When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to 0 disable.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.turboThreshold, https://api.highcharts.com/highstock/plotOptions.heatmap.turboThreshold, https://api.highcharts.com/gantt/plotOptions.heatmap.turboThreshold
  - setTurboThreshold
```
void setTurboThreshold(double value)
```
    (Highcharts, Highstock, Gantt) When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to 0 disable.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.turboThreshold, https://api.highcharts.com/highstock/plotOptions.heatmap.turboThreshold, https://api.highcharts.com/gantt/plotOptions.heatmap.turboThreshold
  - getVisible
```
boolean getVisible()
```
    (Highcharts, Highmaps) Set the initial visibility of the series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.visible, https://api.highcharts.com/highmaps/plotOptions.heatmap.visible
  - setVisible
```
void setVisible(boolean value)
```
    (Highcharts, Highmaps) Set the initial visibility of the series.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.visible, https://api.highcharts.com/highmaps/plotOptions.heatmap.visible
  - getZIndex
```
double getZIndex()
```
    (Highmaps) Define the z index of the series.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.zIndex
  - setZIndex
```
void setZIndex(double value)
```
    (Highmaps) Define the z index of the series.
    
    See Also:
    
    https://api.highcharts.com/highmaps/plotOptions.heatmap.zIndex
  - getZoneAxis
```
@Nullable
String getZoneAxis()
```
    (Highcharts, Highstock) Defines the Axis on which the zones are applied.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.zoneAxis, https://api.highcharts.com/highstock/plotOptions.heatmap.zoneAxis
  - setZoneAxis
```
void setZoneAxis(String value)
```
    (Highcharts, Highstock) Defines the Axis on which the zones are applied.
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.zoneAxis, https://api.highcharts.com/highstock/plotOptions.heatmap.zoneAxis
  - getZones
```
@Nullable
Array<PlotHeatmapZonesOptions> getZones()
```
    (Highcharts, Highstock) An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the zoneAxis option. The zone definitions have to be in ascending order regarding to the value. In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.zones, https://api.highcharts.com/highstock/plotOptions.heatmap.zones
  - setZones
```
void setZones(Array<PlotHeatmapZonesOptions> value)
```
    (Highcharts, Highstock) An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the zoneAxis option. The zone definitions have to be in ascending order regarding to the value. In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).
    
    See Also:
    
    https://api.highcharts.com/highcharts/plotOptions.heatmap.zones, https://api.highcharts.com/highstock/plotOptions.heatmap.zones

Interface PlotHeatmapOptions

Nested Class Summary

Method Summary

Methods inherited from interface js.lang.Any

Methods inherited from interface org.teavm.jso.JSObject

Method Detail

getAllAreas

setAllAreas

getAllowPointSelect

setAllowPointSelect

getAnimation

setAnimation

setAnimation

getBoostThreshold

setBoostThreshold

getBorderColor

setBorderColor

getBorderWidth

setBorderWidth

getClassName

setClassName

getClip

setClip

getColor

setColor

setColor

setColor

getColorAxis

setColorAxis

getColorIndex

setColorIndex

getColsize

setColsize

getCompare

setCompare

getCompareBase

setCompareBase

getCompareStart

setCompareStart

getConnectors

setConnectors

getCropThreshold

setCropThreshold

getCursor

setCursor

setCursor

getDataGrouping

setDataGrouping

getDataLabels

setDataLabels

getDescription

setDescription

getDragDrop

setDragDrop

getEnableMouseTracking

setEnableMouseTracking

getEvents

setEvents

getExposeElementToA11y

setExposeElementToA11y

getGapSize

setGapSize

getGapUnit

setGapUnit

getJoinBy

setJoinBy

setJoinBy

getKeys

setKeys

getLabel

setLabel

getLinkedTo

setLinkedTo

getNavigatorOptions

setNavigatorOptions

getNegativeColor

setNegativeColor

setNegativeColor

setNegativeColor

getNullColor