|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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>
public abstract class BaseMapOptions<T extends BaseMapOptions>
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions |
---|
PlotOptions.Cursor, PlotOptions.PointPlacement, PlotOptions.Stacking |
Constructor Summary | |
---|---|
BaseMapOptions()
|
Method Summary | |
---|---|
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 |
---|
public BaseMapOptions()
Method Detail |
---|
public T setBorderColor(String borderColor)
mapPlotOptions.setOption("borderColor", "red");
The border color of the map areas. Defaults to silver.
borderColor
- The value to set as the border color for map charts.
BaseMapOptions
instance for convenient method chaining.public T setBorderWidth(Number borderWidth)
mapPlotOptions.setOption("borderWidth", 2);
The border width of each map area. Defaults to 1.
borderWidth
- The value to set as the width of the border of a map area.
BaseMapOptions
instance for convenient method chaining.public T setHoverStateBorderColor(String hoverStateBorderColor)
mapPlotOptions.setOption("states/hover/borderColor", "red");
The border color of the point in this state.
hoverStateBorderColor
- The border color of the point in the hover state.
BaseMapOptions
instance for convenient method chaining.public T setHoverStateBorderWidth(Number hoverStateBorderWidth)
mapPlotOptions.setOption("states/hover/borderWidth", 2);
The border width of the point in this state.
hoverStateBorderWidth
- The border width of map areas in the 'hover' state.
BaseMapOptions
instance for convenient method chaining.public T setHoverStateBrightness(Number hoverStateBrightness)
mapPlotOptions.setOption("states/hover/brightness", 1);
The relative brightness of the point when hovered, relative to the normal point color. Defaults to 0.2.
hoverStateBrightness
- The brightness of map areas in the 'hover' state
BaseMapOptions
instance for convenient method chaining.public T setHoverStateColor(String color)
mapPlotOptions.setOption("states/hover/color", "red");
The color of the shape in the 'hover' state.
color
- The color, as a String, of a map area in the 'hover' state.
BaseMapOptions
instance for convenient method chaining.public T setHoverStateEnabled(boolean hoverStateEnabled)
mapPlotOptions.setOption("states/hover/enabled", false);
Enable separate styles for the series in different states. Defaults to true.
setHoverStateEnabled
in class PlotOptions<T extends BaseMapOptions>
hoverStateEnabled
- Whether to enable separate styles for map areas in the 'normal' state.
BaseMapOptions
instance for convenient method chaining.public T setNormalStateAnimation(Animation normalStateAnimation)
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.
normalStateAnimation
- An instance of the Animation
class representing animation options
for the map area in the 'normal' state.
BaseMapOptions
instance for convenient method chaining.public T setNormalStateAnimation(Boolean normalStateAnimation)
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.
normalStateAnimation
- Whether to enable animation for a map area in the 'normal' state.
BaseMapOptions
instance for convenient method chaining.public T setSelectStateBorderColor(String selectStateBorderColor)
mapPlotOptions.setOption("states/select/borderColor", "red");
The border color of the point in this state
selectStateBorderColor
- The border color of the selected map area
BaseMapOptions
instance for convenient method chaining.public T setSelectStateBorderWidth(Number selectStateBorderWidth)
mapPlotOptions.setOption("states/select/borderWidth", 2);
The border width of the point in this state
selectStateBorderWidth
- the width of the border of the selected map area.
BaseMapOptions
instance for convenient method chaining.public T setSelectStateColor(String selectStateColor)
mapPlotOptions.setOption("states/select/color", "silver");
The color of the shape in this state.
selectStateColor
- The color of the map area in the 'select' state.
BaseMapOptions
instance for convenient method chaining.public T setSelectStateEnabled(Boolean selectStateEnabled)
mapPlotOptions.setOption("states/select/enabled", false);
Enable separate styles for the series in different states. Defaults to true.
selectStateEnabled
- Whether to enable a separate style for map areas in the 'select' state.
BaseMapOptions
instance for convenient method chaining.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |