Class HeatMapChart

java.lang.Object

org.knowm.xchart.internal.chartpart.Chart<HeatMapStyler, HeatMapSeries>

org.knowm.xchart.HeatMapChart

public class HeatMapChart
extends Chart<HeatMapStyler, HeatMapSeries>

Field Summary

Fields

Modifier and Type	Field	Description
private HeatMapSeries	heatMapSeries

Fields inherited from class Chart

annotations, axisPair, chartTitle, legend, plot, seriesMap, styler

Constructor Summary

Constructors

Constructor	Description
HeatMapChart(int width, int height)	Constructor - the default Chart Theme will be used (XChartTheme)
HeatMapChart(int width, int height, Styler.ChartTheme chartTheme)	Constructor
HeatMapChart(int width, int height, Theme theme)	Constructor
HeatMapChart(HeatMapChartBuilder heatMapChartBuilder)	Constructor

Method Summary

Modifier and Type	Method	Description
HeatMapSeries	addSeries(String seriesName, int[] xData, int[] yData, int[][] heatData)	Add a series for a HeatMap type chart using int arrays
HeatMapSeries	addSeries(String seriesName, List<?> xData, List<?> yData, List<Number[]> heatData)	Add a series for a HeatMap type chart using List<?>
private List<Integer>	arrayToList(int[] data)
private List<Number[]>	arrayToList(int[][] heatData)
HeatMapSeries	getHeatMapSeries()
void	paint(Graphics2D g, int width, int height)
private void	prepareForPaint()
private void	sanityCheck(List<?> xData, List<?> yData, List<Number[]> heatData)
HeatMapSeries	updateSeries(String seriesName, int[] xData, int[] yData, int[][] heatData)	Update a series by updating the X-Axis, Y-Axis and heat data
HeatMapSeries	updateSeries(String seriesName, List<?> xData, List<?> yData, List<Number[]> heatData)	Update a series by updating the X-Axis, Y-Axis and heat data

Methods inherited from class Chart

addAnnotation, getChartXFromCoordinate, getChartYFromCoordinate, getChartYFromCoordinate, getHeight, getScreenXFromChart, getScreenYFromChart, getScreenYFromChart, getSeriesMap, getStyler, getTitle, getWidth, getXAxisTitle, getYAxisGroupTitle, getYAxisLeftWidth, getYAxisTitle, paintBackground, removeSeries, setCustomXAxisTickLabelsFormatter, setCustomYAxisTickLabelsFormatter, setHeight, setTitle, setWidth, setXAxisTitle, setYAxisGroupTitle, setYAxisTitle

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

heatMapSeries

private HeatMapSeries heatMapSeries

Constructor Details

HeatMapChart

public HeatMapChart(int width,
 int height)

Constructor - the default Chart Theme will be used (XChartTheme)

Parameters:

width -

height -

HeatMapChart

public HeatMapChart(int width,
 int height,
 Theme theme)

Constructor

Parameters:

width -

height -

theme - - pass in a instance of Theme class, probably a custom Theme.

HeatMapChart

public HeatMapChart(int width,
 int height,
 Styler.ChartTheme chartTheme)

Constructor

Parameters:

width -

height -

chartTheme - - pass in the desired ChartTheme enum

HeatMapChart

public HeatMapChart(HeatMapChartBuilder heatMapChartBuilder)

Constructor

Parameters:

heatMapChartBuilder -

Method Details

addSeries

public HeatMapSeries addSeries(String seriesName,
 int[] xData,
 int[] yData,
 int[][] heatData)

Add a series for a HeatMap type chart using int arrays

Parameters:

seriesName -

xData - the X-Axis data

yData - the Y-Axis data

heatData - the heat data

Returns:

addSeries

public HeatMapSeries addSeries(String seriesName,
 List<?> xData,
 List<?> yData,
 List<Number[]> heatData)

Add a series for a HeatMap type chart using List<?>

Parameters:

seriesName -

xData - the X-Axis data

yData - Y-Axis data

heatData - the heat data

Returns:

updateSeries

public HeatMapSeries updateSeries(String seriesName,
 int[] xData,
 int[] yData,
 int[][] heatData)

Update a series by updating the X-Axis, Y-Axis and heat data

Parameters:

seriesName -

xData -

yData -

heatData - heat data value, {{1,5,3,7,...},{8,4,5,8,...},{1,9,12,15,...},...}

Returns:

updateSeries

public HeatMapSeries updateSeries(String seriesName,
 List<?> xData,
 List<?> yData,
 List<Number[]> heatData)

Update a series by updating the X-Axis, Y-Axis and heat data

Parameters:

seriesName -

xData -

yData -

heatData - heat data, {[0,0,1],[0,1,3],[0,2,2],[0,3,18],[1,0,26],[1,1,6],[1,2,7],...}

Returns:

getHeatMapSeries

public HeatMapSeries getHeatMapSeries()

paint

public void paint(Graphics2D g,
 int width,
 int height)

Specified by:

paint in class Chart<HeatMapStyler, HeatMapSeries>

arrayToList

private List<Integer> arrayToList(int[] data)

arrayToList

private List<Number[]> arrayToList(int[][] heatData)

sanityCheck

private void sanityCheck(List<?> xData,
 List<?> yData,
 List<Number[]> heatData)

prepareForPaint

private void prepareForPaint()