HeatMap

Class for drawing a heat map.

Members

Functions

coldColor
Color coldColor()
Undocumented in source. Be warned that the author may not have intended to support it.
coldColor
This coldColor(Color newColor)
Undocumented in source. Be warned that the author may not have intended to support it.
colors
Color[] colors()
colors
This colors(Color[] newColors)

Set the colors to be used for this HeatMap as an array from coldest (smallest value) to warmest (largest value). newColors.length must be >= 2.

drawLegendSymbol
void drawLegendSymbol(FigureBase fig, PlotRect where)
Undocumented in source. Be warned that the author may not have intended to support it.
drawPlot
void drawPlot(Figure form, double leftMargin, double topMargin, double plotWidth, double plotHeight)
Undocumented in source. Be warned that the author may not have intended to support it.
enforceRectangular
void enforceRectangular()
Undocumented in source. Be warned that the author may not have intended to support it.
hasLegend
bool hasLegend()
Undocumented in source. Be warned that the author may not have intended to support it.
heatMapDefaultBounds
void heatMapDefaultBounds()
Undocumented in source. Be warned that the author may not have intended to support it.
hotColor
Color hotColor()
Undocumented in source. Be warned that the author may not have intended to support it.
hotColor
This hotColor(Color newColor)
Undocumented in source. Be warned that the author may not have intended to support it.
legendText
This legendText(string ignored)

Throws an exception. Heat maps aren't allowed to have legends.

nCols
uint nCols()
nRows
uint nRows()
setMinMax
void setMinMax()
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

noCopy
HeatMap noCopy(double[][] mat)

Create a heat map w/o copying data.

opCall
HeatMap opCall(R data)

Create a heat map from a matrix represented as a range of ranges. The matrix must be rectangular. The elements of the ranges must be implicitly convertible to double.

Variables

deprecatedMsg
enum string deprecatedMsg;
Undocumented in source.

Inherited Members

From Plot

upperLim
double upperLim;
Undocumented in source.
lowerLim
double lowerLim;
Undocumented in source.
leftLim
double leftLim;
Undocumented in source.
rightLim
double rightLim;
Undocumented in source.
_legendText
string _legendText;
Undocumented in source.
resetLimits
void resetLimits(Figure figure)
Undocumented in source. Be warned that the author may not have intended to support it.
measureLegend
PlotSize measureLegend(Font legendFont, FigureBase fig)
Undocumented in source. Be warned that the author may not have intended to support it.
drawLegendSymbol
void drawLegendSymbol(FigureBase fig, PlotRect where)
Undocumented in source.
drawPlot
void drawPlot(Figure , double , double , double , double )
Undocumented in source.
hasLegend
bool hasLegend()

Returns true if this plot type supports legends, otherwise false.

toFigure
Figure toFigure()

Convenience method that instantiates a Figure object with this plot. Useful for creating single-plot figures w/o a lot of boilerplate.

toLabeledFigure
Figure toLabeledFigure()

Instantiates a Figure object with this plot and also places the default axes and tick labeling and title for the plot type, if any, on the Figure. If a plot type has no default labeling, simply forwards to toFigure().

leftMost
double leftMost()

The leftmost point on the plot.

rightMost
double rightMost()

The rightmost point on the plot.

topMost
double topMost()

The topmost point on the plot.

bottomMost
double bottomMost()

The bottommost point on the plot.

legendText
string legendText()
legendText
This legendText(string newText)

Meta