# Index

C E G H I M O S
All Classes and Interfaces|All Packages|Constant Field Values

## C

Configuration - Search tag in class org.tc33.jheatchart.HeatChart
  Section

## E

Example - Search tag in org.tc33.jheatchart.HeatChart.setZValues(double[][], double, double)
  Section

## G

getAxisColour() - Method in class org.tc33.jheatchart.HeatChart
  Returns the colour that is set to be used for the axis bars.
getAxisLabelColour() - Method in class org.tc33.jheatchart.HeatChart
  Returns the current colour of the axis labels.
getAxisLabelsFont() - Method in class org.tc33.jheatchart.HeatChart
  Returns the font that describes the visual style of the labels of the axis.
getAxisThickness() - Method in class org.tc33.jheatchart.HeatChart
  Returns the width of the axis bars in pixels.
getAxisValuesColour() - Method in class org.tc33.jheatchart.HeatChart
  Returns the colour of the axis values as they will be painted along the axis bars.
getAxisValuesFont() - Method in class org.tc33.jheatchart.HeatChart
  Returns the font which describes the visual style of the axis values.
getBackgroundColour() - Method in class org.tc33.jheatchart.HeatChart
  Returns an object that represents the colour to be used as the background for the whole chart.
getCellHeight() - Method in class org.tc33.jheatchart.HeatChart
  Deprecated.
  As of release 0.6, replaced by `getCellSize()`
getCellSize() - Method in class org.tc33.jheatchart.HeatChart
  Returns the size of each individual data cell that constitutes a value in the x,y,z space.
getCellWidth() - Method in class org.tc33.jheatchart.HeatChart
  Deprecated.
  As of release 0.6, replaced by `getCellSize()`
getChartGraphics(Graphics2D) - Method in class org.tc33.jheatchart.HeatChart
  Writes the heatmap to chartGraphics - added by JE
getChartHeight() - Method in class org.tc33.jheatchart.HeatChart
  Deprecated.
  As of release 0.6, replaced by `getChartSize()`
getChartImage() - Method in class org.tc33.jheatchart.HeatChart
  Generates and returns a new chart `Image` configured according to this object's currently held settings.
getChartImage(boolean) - Method in class org.tc33.jheatchart.HeatChart
  Generates and returns a new chart `Image` configured according to this object's currently held settings.
getChartMargin() - Method in class org.tc33.jheatchart.HeatChart
  Returns the width of the margin in pixels to be left as empty space around the heat map element.
getChartSize() - Method in class org.tc33.jheatchart.HeatChart
  Returns the size of the chart in pixels as calculated according to the cell dimensions, chart margin and other size settings.
getChartWidth() - Method in class org.tc33.jheatchart.HeatChart
  Deprecated.
  As of release 0.6, replaced by `getChartSize()`
getColourScale() - Method in class org.tc33.jheatchart.HeatChart
  Returns the scale that is currently in use to map z-value to colour.
getHighValue() - Method in class org.tc33.jheatchart.HeatChart
  Returns the high value.
getHighValueColour() - Method in class org.tc33.jheatchart.HeatChart
  Returns the colour that is currently to be displayed for the heat map cells with the highest z-value in the dataset.
getLowValue() - Method in class org.tc33.jheatchart.HeatChart
  Returns the low value.
getLowValueColour() - Method in class org.tc33.jheatchart.HeatChart
  Returns the colour that is currently to be displayed for the heat map cells with the lowest z-value in the dataset.
getTitle() - Method in class org.tc33.jheatchart.HeatChart
  Returns the String that will be used as the title of any successive calls to generate a chart.
getTitleColour() - Method in class org.tc33.jheatchart.HeatChart
  Returns the `Color` that represents the colour the title text should be painted in.
getTitleFont() - Method in class org.tc33.jheatchart.HeatChart
  Returns the `Font` that describes the visual style of the title.
getXAxisLabel() - Method in class org.tc33.jheatchart.HeatChart
  Returns the String that will be displayed as a description of the x-axis in any generated charts.
getXAxisValuesFrequency() - Method in class org.tc33.jheatchart.HeatChart
  Returns the frequency of the values displayed along the x-axis.
getXValues() - Method in class org.tc33.jheatchart.HeatChart
  Returns the x-values which are currently set to display along the x-axis.
getYAxisLabel() - Method in class org.tc33.jheatchart.HeatChart
  Returns the String that will be displayed as a description of the y-axis in any generated charts.
getYAxisValuesFrequency() - Method in class org.tc33.jheatchart.HeatChart
  Returns the frequency of the values displayed along the y-axis.
getYValues() - Method in class org.tc33.jheatchart.HeatChart
  Returns the y-values which are currently set to display along the y-axis.
getZValues() - Method in class org.tc33.jheatchart.HeatChart
  Returns the 2-dimensional array of z-values currently in use.

## H

HeatChart - Class in org.tc33.jheatchart
  The `HeatChart` class describes a chart which can display 3-dimensions of values - x,y and z, where x and y are the usual 2-dimensional axis and z is portrayed by colour intensity.
HeatChart(double[][]) - Constructor for class org.tc33.jheatchart.HeatChart
  Constructs a heatmap for the given z-values against x/y-values that by default will be the values 0 to n-1, where n is the number of columns or rows.
HeatChart(double[][], double, double) - Constructor for class org.tc33.jheatchart.HeatChart
  Constructs a heatmap for the given z-values against x/y-values that by default will be the values 0 to n-1, where n is the number of columns or rows.

## I

Instantiation - Search tag in class org.tc33.jheatchart.HeatChart
  Section
isShowXAxisValues() - Method in class org.tc33.jheatchart.HeatChart
  Returns whether axis values are to be shown at all for the x-axis.
isShowYAxisValues() - Method in class org.tc33.jheatchart.HeatChart
  Returns whether axis values are to be shown at all for the y-axis.
isXValuesHorizontal() - Method in class org.tc33.jheatchart.HeatChart
  Returns whether the text of the values along the x-axis are to be drawn horizontally left-to-right, or vertically top-to-bottom.
isYValuesHorizontal() - Method in class org.tc33.jheatchart.HeatChart
  Returns whether the text of the values along the y-axis are to be drawn horizontally left-to-right, or vertically top-to-bottom.

## M

max(double[][]) - Static method in class org.tc33.jheatchart.HeatChart
  Finds and returns the maximum value in a 2-dimensional array of doubles.
min(double[][]) - Static method in class org.tc33.jheatchart.HeatChart
  Finds and returns the minimum value in a 2-dimensional array of doubles.

## O

Object axis values - Search tag in class org.tc33.jheatchart.HeatChart
  Section
Offset and Interval - Search tag in class org.tc33.jheatchart.HeatChart
  Section
org.tc33.jheatchart - package org.tc33.jheatchart
Output - Search tag in class org.tc33.jheatchart.HeatChart
  Section

## S

saveToFile(File) - Method in class org.tc33.jheatchart.HeatChart
  Generates a new chart `Image` based upon the currently held settings and then attempts to save that image to disk, to the location provided as a File parameter.
SCALE_EXPONENTIAL - Static variable in class org.tc33.jheatchart.HeatChart
  A basic exponential scale value of 3.0.
SCALE_LINEAR - Static variable in class org.tc33.jheatchart.HeatChart
  The linear scale value of 1.0.
SCALE_LOGARITHMIC - Static variable in class org.tc33.jheatchart.HeatChart
  A basic logarithmic scale value of 0.3.
setAxisColour(Color) - Method in class org.tc33.jheatchart.HeatChart
  Sets the colour to be used on the axis bars.
setAxisLabelColour(Color) - Method in class org.tc33.jheatchart.HeatChart
  Sets the colour of the text displayed as axis labels.
setAxisLabelsFont(Font) - Method in class org.tc33.jheatchart.HeatChart
  Sets the font that describes the visual style of the axis labels.
setAxisThickness(int) - Method in class org.tc33.jheatchart.HeatChart
  Sets the width of the axis bars in pixels.
setAxisValuesColour(Color) - Method in class org.tc33.jheatchart.HeatChart
  Sets the colour to be used for the axis values as they will be painted along the axis bars.
setAxisValuesFont(Font) - Method in class org.tc33.jheatchart.HeatChart
  Sets the font which describes the visual style of the axis values.
setBackgroundColour(Color) - Method in class org.tc33.jheatchart.HeatChart
  Sets the colour to be used on the background of the chart.
setCellHeight(int) - Method in class org.tc33.jheatchart.HeatChart
  Deprecated.
  As of release 0.6, replaced by `setCellSize(Dimension)`
setCellSize(Dimension) - Method in class org.tc33.jheatchart.HeatChart
  Sets the size of each individual cell that constitutes a value in x,y,z data space.
setCellWidth(int) - Method in class org.tc33.jheatchart.HeatChart
  Deprecated.
  As of release 0.6, replaced by `setCellSize(Dimension)`
setChartMargin(int) - Method in class org.tc33.jheatchart.HeatChart
  Sets the width of the margin in pixels to be left as empty space around the heat map element.
setColourScale(double) - Method in class org.tc33.jheatchart.HeatChart
  Sets the scale that is currently in use to map z-value to colour.
setHighValueColour(Color) - Method in class org.tc33.jheatchart.HeatChart
  Sets the colour to be used to fill cells of the heat map with the highest z-values in the dataset.
setLowValueColour(Color) - Method in class org.tc33.jheatchart.HeatChart
  Sets the colour to be used to fill cells of the heat map with the lowest z-values in the dataset.
setShowXAxisValues(boolean) - Method in class org.tc33.jheatchart.HeatChart
  Sets whether axis values are to be shown at all for the x-axis.
setShowYAxisValues(boolean) - Method in class org.tc33.jheatchart.HeatChart
  Sets whether axis values are to be shown at all for the y-axis.
setTitle(String) - Method in class org.tc33.jheatchart.HeatChart
  Sets the String that will be used as the title of any successive calls to generate a chart.
setTitleColour(Color) - Method in class org.tc33.jheatchart.HeatChart
  Sets the `Color` that describes the colour to be used for the chart title String.
setTitleFont(Font) - Method in class org.tc33.jheatchart.HeatChart
  Sets a new `Font` to be used in rendering the chart's title String.
setXAxisLabel(String) - Method in class org.tc33.jheatchart.HeatChart
  Sets the String that will be displayed as a description of the x-axis in any generated charts.
setXAxisValuesFrequency(int) - Method in class org.tc33.jheatchart.HeatChart
  Sets the frequency of the values displayed along the x-axis.
setXValues(double, double) - Method in class org.tc33.jheatchart.HeatChart
  Sets the x-values which are plotted along the x-axis.
setXValues(Object[]) - Method in class org.tc33.jheatchart.HeatChart
  Sets the x-values which are plotted along the x-axis.
setXValuesHorizontal(boolean) - Method in class org.tc33.jheatchart.HeatChart
  Sets whether the text of the values along the x-axis should be drawn horizontally left-to-right, or vertically top-to-bottom.
setYAxisLabel(String) - Method in class org.tc33.jheatchart.HeatChart
  Sets the String that will be displayed as a description of the y-axis in any generated charts.
setYAxisValuesFrequency(int) - Method in class org.tc33.jheatchart.HeatChart
  Sets the frequency of the values displayed along the y-axis.
setYValues(double, double) - Method in class org.tc33.jheatchart.HeatChart
  Sets the y-values which are plotted along the y-axis.
setYValues(Object[]) - Method in class org.tc33.jheatchart.HeatChart
  Sets the y-values which are plotted along the y-axis.
setYValuesHorizontal(boolean) - Method in class org.tc33.jheatchart.HeatChart
  Sets whether the text of the values along the y-axis should be drawn horizontally left-to-right, or vertically top-to-bottom.
setZValues(double[][]) - Method in class org.tc33.jheatchart.HeatChart
  Replaces the z-values array.
setZValues(double[][], double, double) - Method in class org.tc33.jheatchart.HeatChart
  Replaces the z-values array.

C E G H I M O S
All Classes and Interfaces|All Packages|Constant Field Values