java.lang.Object
- org.zkoss.chart.Optionable
- - org.zkoss.chart.plotOptions.SeriesPlotOptions
  - - org.zkoss.chart.plotOptions.HeatmapPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

TilemapPlotOptions
```
public class HeatmapPlotOptions
extends SeriesPlotOptions
```
An option for heatmap plot.
All the options in this class support DynamicalAttribute.

Author:

hanhsu

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.zkoss.chart.Optionable
  NOT_NULL_VALUE, options

Constructor Summary

Constructors
Constructor Description

HeatmapPlotOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Color`	`getBorderColor()`	Returns the color of the border surrounding each column or bar.
`Object`	`getBorderRadius()`	Returns the corner radius of the border surrounding each column or bar.
`Number`	`getBorderWidth()`	Returns the width of the border surrounding each column or bar.
`List<Color>`	`getColors()`	Returns a series specific or series type specific color set to apply instead of the global `Charts.getColors()` when `SeriesPlotOptions.setColorByPoint(boolean)` is true.
`Number`	`getColsize()`	Returns the column size - how many X axis units each column in the heatmap should span.
`Color`	`getNullColor()`	Returns the color applied to null points.
`Number`	`getPointPadding()`	Returns padding between each column or bar, in x axis units.
`Number`	`getRowsize()`	Returns the row size - how many Y axis units each heatmap row should span.
`boolean`	`isInterpolation()`	Returns whether make the heatmap render its data points as an interpolated image.
`void`	`setBorderColor(String color)`	Sets the color of the border surrounding each column or bar.
`void`	`setBorderColor(Color color)`	Sets the color of the border surrounding each column or bar.
`void`	`setBorderColor(LinearGradient color)`	Sets the color of the border surrounding each column or bar.
`void`	`setBorderColor(RadialGradient color)`	Sets the color of the border surrounding each column or bar.
`void`	`setBorderWidth(Number borderWidth)`	Sets the width of the border surrounding each column or bar.
`void`	`setColors(String... source)`	Sets a series specific or series type specific color set to apply instead of the global `Charts.getColors()` when `SeriesPlotOptions.setColorByPoint(boolean)` is true.
`void`	`setColors(List<Color> colors)`	Sets a series specific or series type specific color set to apply instead of the global `Charts.getColors()` when `SeriesPlotOptions.setColorByPoint(boolean)` is true.
`void`	`setColsize(Number colsize)`	Sets the column size - how many X axis units each column in the heatmap should span.
`void`	`setInterpolation(Boolean interpolation)`	Sets whether make the heatmap render its data points as an interpolated image.
`void`	`setNullColor(String color)`	Sets the color applied to null points.
`void`	`setNullColor(Color color)`	Sets the color applied to null points.
`void`	`setNullColor(LinearGradient color)`	Sets the color applied to null points.
`void`	`setNullColor(RadialGradient color)`	Sets the color of the border surrounding each column or bar.
`void`	`setPointPadding(Number pointPadding)`	Sets padding between each column or bar, in x axis units.
`void`	`setRowsize(Number rowsize)`	Sets the row size - how many Y axis units each heatmap row should span.

Methods inherited from class org.zkoss.chart.plotOptions.SeriesPlotOptions
addDataLabels, getAccessibility, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getColor, getColorAxis, getColorIndex, getColorKey, getConnectorWidth, getCropThreshold, getCursor, getCustom, getDashStyle, getDataLabels, getDataLabelsList, getDataSorting, getDepth, getDescription, getDragDrop, getFindNearestPointBy, getGroupPadding, getId, getIndex, getKeys, getLabel, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, getNeckHeight, getNeckWidth, getNegativeColor, getOnPoint, getOpacity, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getStacking, getStates, getStep, getThreshold, getTooltip, getTurboThreshold, getZoneAxis, getZones, isAllowPointSelect, isAnimation, isCenterInCategory, isClip, isColorByPoint, isConnectEnds, isConnectNulls, isCrisp, isDataAsColumns, isEnableMouseTracking, isGetExtremesFromAll, isIncludeInDataExport, isRelativeXValue, isSelected, isShadow, isShowCheckbox, isShowInLegend, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isStickyTracking, isVisible, newDataLabels, setAccessibility, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setBorderRadius, setBorderRadius, setCenter, setCenter, setCenterInCategory, setClassName, setClip, setColor, setColor, setColor, setColor, setColorAxis, setColorAxis, setColorAxis, setColorByPoint, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setConnectorWidth, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setDataAsColumns, setDataLabels, setDataLabels, setDataSorting, setDepth, setDescription, setDragDrop, setEnableMouseTracking, setFindNearestPointBy, setGetExtremesFromAll, setGroupPadding, setId, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNeckHeight, setNeckWidth, setNegativeColor, setNegativeColor, setNegativeColor, setNegativeColor, setOnPoint, setOpacity, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointPlacement, setPointStart, setRelativeXValue, setSelected, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStacking, setStates, setStep, setStickyTracking, setThreshold, setTooltip, setTurboThreshold, setVisible, setWidth, setZoneAxis, setZones, setZones

Methods inherited from class org.zkoss.chart.Optionable
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.chart.OptionDataListener
onChange

- Constructor Detail
  - HeatmapPlotOptions
```
public HeatmapPlotOptions()
```
- Method Detail
  - isInterpolation
```
public boolean isInterpolation()
```
    Returns whether make the heatmap render its data points as an interpolated image.
    Default: false
    
    Since:
    
    11.2.0.0
  - setInterpolation
```
public void setInterpolation(Boolean interpolation)
```
    Sets whether make the heatmap render its data points as an interpolated image.
    
    Since:
    
    11.2.0.0
  - getBorderColor
```
public Color getBorderColor()
```
    Returns the color of the border surrounding each column or bar.
    Default: "#FFFFFF".
  - setBorderColor
```
public void setBorderColor(Color color)
```
    Sets the color of the border surrounding each column or bar.
  - setBorderColor
```
public void setBorderColor(String color)
```
    Sets the color of the border surrounding each column or bar.
  - setBorderColor
```
public void setBorderColor(LinearGradient color)
```
    Sets the color of the border surrounding each column or bar.
  - setBorderColor
```
public void setBorderColor(RadialGradient color)
```
    Sets the color of the border surrounding each column or bar.
  - getBorderRadius
```
public Object getBorderRadius()
```
    Returns the corner radius of the border surrounding each column or bar.
    Default: 0.
    
    Overrides:
    
    getBorderRadius in class SeriesPlotOptions
    
    Returns:
    
    corner radius of the border surrounding each column or bar.
  - getBorderWidth
```
public Number getBorderWidth()
```
    Returns the width of the border surrounding each column or bar.
    Default: 1.
    
    Overrides:
    
    getBorderWidth in class SeriesPlotOptions
    
    Returns:
    
    width of the border surrounding each column or bar.
  - setBorderWidth
```
public void setBorderWidth(Number borderWidth)
```
    Sets the width of the border surrounding each column or bar.
    
    Overrides:
    
    setBorderWidth in class SeriesPlotOptions
  - getColors
```
public List<Color> getColors()
```
    Returns a series specific or series type specific color set to apply instead of the global Charts.getColors() when SeriesPlotOptions.setColorByPoint(boolean) is true.
  - setColors
```
public void setColors(List<Color> colors)
```
    Sets a series specific or series type specific color set to apply instead of the global Charts.getColors() when SeriesPlotOptions.setColorByPoint(boolean) is true.
  - setColors
```
public void setColors(String... source)
```
    Sets a series specific or series type specific color set to apply instead of the global Charts.getColors() when SeriesPlotOptions.setColorByPoint(boolean) is true.
  - getColsize
```
public Number getColsize()
```
    Returns the column size - how many X axis units each column in the heatmap should span.
    Default: 1.
    
    Returns:
    
    column size - how many X axis units each column in the heatmap should span.
  - setColsize
```
public void setColsize(Number colsize)
```
    Sets the column size - how many X axis units each column in the heatmap should span.
  - getNullColor
```
public Color getNullColor()
```
    Returns the color applied to null points.
    Default: "#f7f7f7".
    
    Since:
    
    7.2.1.0
  - setNullColor
```
public void setNullColor(Color color)
```
    Sets the color applied to null points.
    
    Since:
    
    7.2.1.0
  - setNullColor
```
public void setNullColor(String color)
```
    Sets the color applied to null points.
    
    Since:
    
    7.2.1.0
  - setNullColor
```
public void setNullColor(LinearGradient color)
```
    Sets the color applied to null points.
    
    Since:
    
    7.2.1.0
  - setNullColor
```
public void setNullColor(RadialGradient color)
```
    Sets the color of the border surrounding each column or bar.
    
    Since:
    
    7.2.1.0
  - getRowsize
```
public Number getRowsize()
```
    Returns the row size - how many Y axis units each heatmap row should span.
    Default: 1.
    
    Returns:
    
    row size - how many Y axis units each heatmap row should span.
  - setRowsize
```
public void setRowsize(Number rowsize)
```
    Sets the row size - how many Y axis units each heatmap row should span.
  - getPointPadding
```
public Number getPointPadding()
```
    Returns padding between each column or bar, in x axis units.
    Default: 0
    
    Since:
    
    10.2.1.0
  - setPointPadding
```
public void setPointPadding(Number pointPadding)
```
    Sets padding between each column or bar, in x axis units. 'pointPadding padding between each column or bar, in x axis units.
    
    Since:
    
    10.2.1.0

Class HeatmapPlotOptions

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

Constructor Summary

Method Summary

Methods inherited from class org.zkoss.chart.plotOptions.SeriesPlotOptions

Methods inherited from class org.zkoss.chart.Optionable

Methods inherited from class java.lang.Object

Methods inherited from interface org.zkoss.chart.OptionDataListener

Constructor Detail

HeatmapPlotOptions

Method Detail

isInterpolation

setInterpolation

getBorderColor

setBorderColor

setBorderColor

setBorderColor

setBorderColor

getBorderRadius

getBorderWidth

setBorderWidth

getColors

setColors

setColors

getColsize

setColsize

getNullColor

setNullColor

setNullColor

setNullColor

setNullColor

getRowsize

setRowsize

getPointPadding

setPointPadding