org.moxieapps.gwt.highcharts.client.plotOptions

Class BaseMapOptions<T extends BaseMapOptions>

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<T>

Direct Known Subclasses:

HeatmapPlotOptions, TreemapPlotOptions

public abstract class BaseMapOptions<T extends BaseMapOptions>
extends PlotOptions<T>

A common base class for HeatmapPlotOptions and other map plot types to prevent code duplication while still maintaining a cleaner way for the user to utilize the method chaining with the generics in place. You should not instantiate this calss directly, but instead use one of its inheriting classes.

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

Constructors

Constructor and Description
BaseMapOptions()

Method Summary

Methods

Modifier and Type	Method and Description
T	setBorderColor(String borderColor) Convenience method for setting the 'borderColor' option of the map plotOptions.
T	setBorderWidth(Number borderWidth) Convenience method for setting the 'borderWidth' option of the map plotOptions.
T	setHoverStateBorderColor(String hoverStateBorderColor) Convenience method for setting the 'borderColor' option of the hover state.
T	setHoverStateBorderWidth(Number hoverStateBorderWidth) Convenience method for setting the 'borderWidth' option of the hover state.
T	setHoverStateBrightness(Number hoverStateBrightness) Convenience method for setting the 'brightness' option of the hover state.
T	setHoverStateColor(String color) Convenience method for setting the 'color' option of the hover state.
T	setHoverStateEnabled(boolean hoverStateEnabled) Convenience method for setting the 'enabled' option of the hover state.
T	setNormalStateAnimation(Animation normalStateAnimation) Convenience method for setting the 'animation' option of the select state.
T	setNormalStateAnimation(Boolean normalStateAnimation) Convenience method for setting the 'animation' option of the select state.
T	setSelectStateBorderColor(String selectStateBorderColor) Convenience method for setting the 'borderColor' option of the select state.
T	setSelectStateBorderWidth(Number selectStateBorderWidth) Convenience method for setting the 'borderWidth' option of the select state.
T	setSelectStateColor(String selectStateColor) Convenience method for setting the 'color' option of the select state.
T	setSelectStateEnabled(Boolean selectStateEnabled) Convenience method for setting the 'enabled' option of the select state.

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

BaseMapOptions

public BaseMapOptions()

Method Detail

setBorderColor

public T setBorderColor(String borderColor)

Convenience method for setting the 'borderColor' option of the map plotOptions. Equivalent to:

     mapPlotOptions.setOption("borderColor", "red");
 

The border color of the map areas. Defaults to silver.

Parameters:

borderColor - The value to set as the border color for map charts.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setBorderWidth

public T setBorderWidth(Number borderWidth)

Convenience method for setting the 'borderWidth' option of the map plotOptions. Equivalent to:

     mapPlotOptions.setOption("borderWidth", 2);
 

The border width of each map area. Defaults to 1.

Parameters:

borderWidth - The value to set as the width of the border of a map area.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setHoverStateBorderColor

public T setHoverStateBorderColor(String hoverStateBorderColor)

Convenience method for setting the 'borderColor' option of the hover state. Equivalent to:

     mapPlotOptions.setOption("states/hover/borderColor", "red");
 

The border color of the point in this state.

Parameters:

hoverStateBorderColor - The border color of the point in the hover state.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setHoverStateBorderWidth

public T setHoverStateBorderWidth(Number hoverStateBorderWidth)

Convenience method for setting the 'borderWidth' option of the hover state. Equivalent to:

     mapPlotOptions.setOption("states/hover/borderWidth", 2);
 

The border width of the point in this state.

Parameters:

hoverStateBorderWidth - The border width of map areas in the 'hover' state.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setHoverStateBrightness

public T setHoverStateBrightness(Number hoverStateBrightness)

Convenience method for setting the 'brightness' option of the hover state. Equivalent to:

     mapPlotOptions.setOption("states/hover/brightness", 1);
 

The relative brightness of the point when hovered, relative to the normal point color. Defaults to 0.2.

Parameters:

hoverStateBrightness - The brightness of map areas in the 'hover' state

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setHoverStateColor

public T setHoverStateColor(String color)

Convenience method for setting the 'color' option of the hover state. Equivalent to:

     mapPlotOptions.setOption("states/hover/color", "red");
 

The color of the shape in the 'hover' state.

Parameters:

color - The color, as a String, of a map area in the 'hover' state.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setHoverStateEnabled

public T setHoverStateEnabled(boolean hoverStateEnabled)

Convenience method for setting the 'enabled' option of the hover state. Equivalent to:

     mapPlotOptions.setOption("states/hover/enabled", false);
 

Enable separate styles for the series in different states. Defaults to true.

Overrides:

setHoverStateEnabled in class PlotOptions<T extends BaseMapOptions>

Parameters:

hoverStateEnabled - Whether to enable separate styles for map areas in the 'normal' state.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setNormalStateAnimation

public T setNormalStateAnimation(Animation normalStateAnimation)

Convenience method for setting the 'animation' option of the select state. Equivalent to:

     mapPlotOptions.setOption("states/normal/animation", new Animation());
 

Animation options for the fill color when returning from hover state to normal state. The animation adds some latency in order to reduce the effect of flickering when hovering in and out of for example an uneven coastline.

Parameters:

normalStateAnimation - An instance of the Animation class representing animation options for the map area in the 'normal' state.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setNormalStateAnimation

public T setNormalStateAnimation(Boolean normalStateAnimation)

Convenience method for setting the 'animation' option of the select state. Equivalent to:

     mapPlotOptions.setOption("states/normal/animation", false);
 

Animation options for the fill color when returning from hover state to normal state. The animation adds some latency in order to reduce the effect of flickering when hovering in and out of for example an uneven coastline. Defaults to true.

Parameters:

normalStateAnimation - Whether to enable animation for a map area in the 'normal' state.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setSelectStateBorderColor

public T setSelectStateBorderColor(String selectStateBorderColor)

Convenience method for setting the 'borderColor' option of the select state. Equivalent to:

     mapPlotOptions.setOption("states/select/borderColor", "red");
 

The border color of the point in this state

Parameters:

selectStateBorderColor - The border color of the selected map area

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setSelectStateBorderWidth

public T setSelectStateBorderWidth(Number selectStateBorderWidth)

Convenience method for setting the 'borderWidth' option of the select state. Equivalent to:

     mapPlotOptions.setOption("states/select/borderWidth", 2);
 

The border width of the point in this state

Parameters:

selectStateBorderWidth - the width of the border of the selected map area.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setSelectStateColor

public T setSelectStateColor(String selectStateColor)

Convenience method for setting the 'color' option of the select state. Equivalent to:

     mapPlotOptions.setOption("states/select/color", "silver");
 

The color of the shape in this state.

Parameters:

selectStateColor - The color of the map area in the 'select' state.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.

setSelectStateEnabled

public T setSelectStateEnabled(Boolean selectStateEnabled)

Convenience method for setting the 'enabled' option of the select state. Equivalent to:

     mapPlotOptions.setOption("states/select/enabled", false);
 

Enable separate styles for the series in different states. Defaults to true.

Parameters:

selectStateEnabled - Whether to enable a separate style for map areas in the 'select' state.

Returns:

A reference to this BaseMapOptions instance for convenient method chaining.