com.vaadin.flow.component.charts.model.HeatSeries API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.component.charts.model.

java.lang.Object
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
- - com.vaadin.flow.component.charts.model.AbstractSeries
  - - com.vaadin.flow.component.charts.model.HeatSeries

All Implemented Interfaces:

Series, Serializable
```
public class HeatSeries
extends AbstractSeries
```
A specialized series for use with HeatMaps

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`HeatSeries()`
`HeatSeries(String name)`	Constructs a HeatSeries with the given name
`HeatSeries(String name, Number[]... values)`	Constructs a HeatSeries with the given name and values

Method Summary

All Methods
Modifier and Type	Method	Description
`void`	`addHeatPoint(int x, int y, Number heatScore)`	Add a single data point to the heat series
`void`	`clear()`
`Number[][]`	`getData()`
`void`	`setData(Number[]... values)`	Sets the numeric data for this series.

Methods inherited from class com.vaadin.flow.component.charts.model.AbstractSeries
getColorAxis, getConfiguration, getId, getName, getPlotOptions, getStack, getxAxis, getyAxis, isVisible, setColorAxis, setConfiguration, setId, setName, setPlotOptions, setStack, setVisible, setVisible, setxAxis, setyAxis, setyAxis, updateSeries

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

- Constructor Detail
  - HeatSeries
```
public HeatSeries()
```
  - HeatSeries
```
public HeatSeries(String name)
```
    Constructs a HeatSeries with the given name
    
    Parameters:
    
    name - The name of this data series.
  - HeatSeries
```
public HeatSeries(String name,
                  Number[]... values)
```
    Constructs a HeatSeries with the given name and values
    
    Parameters:
    
    name - the name of the series
    
    values - x-y-heatScore triplets
- Method Detail
  - setData
```
public void setData(Number[]... values)
```
    Sets the numeric data for this series.
    
    Parameters:
    
    values - x-y-heatScore triplets
  - getData
```
public Number[][] getData()
```
    Returns:
    
    the raw data in this series
    
    See Also:
    
    setData(Number[]...)
  - addHeatPoint
```
public void addHeatPoint(int x,
                         int y,
                         Number heatScore)
```
    Add a single data point to the heat series
    
    Parameters:
    
    x - the x coordinate of the point
    
    y - the y coordinate of the point
    
    heatScore - the heat score of the point
  - clear
```
public void clear()
```