org.moxieapps.gwt.highcharts.client.plotOptions
Class HeatmapPlotOptions

java.lang.Object
  org.moxieapps.gwt.highcharts.client.Configurable<T>
      org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions<T>
          org.moxieapps.gwt.highcharts.client.plotOptions.BaseMapOptions<HeatmapPlotOptions>
              org.moxieapps.gwt.highcharts.client.plotOptions.HeatmapPlotOptions

public class HeatmapPlotOptions
extends BaseMapOptions<HeatmapPlotOptions>

represents the general plot options available for all heatmap type series, which can be set wither generically on the chart via the BaseChart.setHeatmapPlotOptions(HeatmapPlotOptions) method or directly on a series via the Series#setPlotOptions(PlotOptions

Note that these options are only needed if you want to specifically control the general options for all heatmap type series in the entire chart. If you instead want to control the options for all series in the chart (not just those of a spline type,) then you can use the SeriesPlotOptions class instead. Or, if you want to control the plot options for just one series (and not all spline type series in the chart,) use the Series#setPlotOptions) method.

Since:

1.7.0

Author:

cskowron@moxiegroup.com (Cory Skowronek)

Nested Class Summary

Nested classes/interfaces inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions

PlotOptions.Cursor, PlotOptions.PointPlacement, PlotOptions.Stacking

Constructor Summary

HeatmapPlotOptions()

Method Summary

HeatmapPlotOptions	setBorderRadius(Number borderRadius) Convenience method for setting the 'borderRadius' option of the heatmap.
HeatmapPlotOptions	setBorderWidth(Number borderWidth) convenience method for setting the 'borderWidth' option of the heatmap.
HeatmapPlotOptions	setColorByPoint(boolean colorByPoint) convenience method for setting the 'colorByPoint' option of the heatmap.
HeatmapPlotOptions	setColors(String... colors) Convenience method for setting the 'colors' option of the heatmap.
HeatmapPlotOptions	setColSize(Number colSize) Convenience method for setting the 'colSize' option of the heatmap.
HeatmapPlotOptions	setRowSize(Number rowSize) Convenience method for setting the 'rowsize' option of the heatmap.

Methods inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.BaseMapOptions

setBorderColor, setHoverStateBorderColor, setHoverStateBorderWidth, setHoverStateBrightness, setHoverStateColor, setHoverStateEnabled, setNormalStateAnimation, setNormalStateAnimation, setSelectStateBorderColor, setSelectStateBorderWidth, setSelectStateColor, setSelectStateEnabled

Methods inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions

getDataLabels, setAllowPointSelect, setAnimation, setAnimation, setBaseDataLabels, setColor, setColor, setCropThreshold, setCursor, setDashStyle, setDataGrouping, setDataLabels, setEnableMouseTracking, setHoverStateLineWidth, setHoverStateMarker, setId, setLegendIndex, setLineWidth, setLinkedTo, setLinkedTo, setMarker, setNegativeColor, setNegativeColor, setPointInterval, setPointPlacement, setPointStart, setSelected, setShadow, setShowCheckbox, setShowInLegend, setStacking, setStickyTracking, setThreshold, setTurboThreshold, setVisible, setZIndex, setZoneAxis, setZones

Methods inherited from class org.moxieapps.gwt.highcharts.client.Configurable

getOptions, setOption

Methods inherited from class java.lang.Object

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

Constructor Detail

HeatmapPlotOptions

public HeatmapPlotOptions()

Method Detail

setBorderRadius

public HeatmapPlotOptions setBorderRadius(Number borderRadius)

Convenience method for setting the 'borderRadius' option of the heatmap. Equivalent to:

     heatmapPlotOptions.setOption("borderRadius", 25);
 

The corner radius of the border surrounding each column or bar. Defaults to 0.

Parameters:

borderRadius - The corner radius of the border surrounding each column or bar.

Returns:

A reference to this HeatmapPlotOptions instance for convenient method chaining.

setBorderWidth

public HeatmapPlotOptions setBorderWidth(Number borderWidth)

convenience method for setting the 'borderWidth' option of the heatmap. Equivalent to:

     heatmapPlotOptions.setOption("borderWidth", true);
 

The width of the border surrounding each column or bar. Defaults to 1.

Overrides:

setBorderWidth in class BaseMapOptions<HeatmapPlotOptions>

Parameters:

borderWidth - The width of the border surrounding each column or bar.

Returns:

A reference to this HeatmapPlotOptions instance for convenient method chaining.

setColorByPoint

public HeatmapPlotOptions setColorByPoint(boolean colorByPoint)

convenience method for setting the 'colorByPoint' option of the heatmap. Equivalent to:

     heatmapPlotOptions.setOption("colorByPoint", true);
 

When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point. Defaults to false.

Parameters:

colorByPoint - Whether the chart should receive one color per series or one color per point.

Returns:

A reference to this HeatmapPlotOptions instance for convenient method chaining.

setColors

public HeatmapPlotOptions setColors(String... colors)

Convenience method for setting the 'colors' option of the heatmap. Equivalent to:

     heatmapPlotOptions.setOption("colors", "#EBEE00", "#FF00FF", "#0000FF");
 

A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.

Parameters:

colors - An array of strings representing the colors to apply to the heatmap.

Returns:

A reference to this HeatmapPlotOptions instance for convenient method chaining.

See Also:

setColorByPoint(boolean)

setColSize

public HeatmapPlotOptions setColSize(Number colSize)

Convenience method for setting the 'colSize' option of the heatmap. Equivalent to:

     heatmapPlotOptions.setOption("colSize", 10);
 

The column size - how many X axis units each column in the heatmap should span. Defaults to 1.

Parameters:

colSize - The number of units on the x-axis the map will span.

Returns:

A reference to this HeatmapPlotOptions instance for convenient method chaining.

setRowSize

public HeatmapPlotOptions setRowSize(Number rowSize)

Convenience method for setting the 'rowsize' option of the heatmap. Equivalent to:

     heatmapPlotOptions.setOption("rowsize", 10);
 

The row size - how many Y axis units each heatmap row should span. Defaults to 1.

Parameters:

rowSize - The number of units on the y-axis the heatmap should span.

Returns:

A reference to this HeatmapPlotOptions instance for convenient method chaining.