Package org.pepstock.charba.client.geo

Class ChoroplethOptions

java.lang.Object

org.pepstock.charba.client.configuration.ConfigurationOptions

org.pepstock.charba.client.configuration.ScalesOptions

org.pepstock.charba.client.geo.ChoroplethOptions

All Implemented Interfaces:

HasAnimation, ConfigurationElement, AddHandlerEventHandler, EventHandler, RemoveHandlerEventHandler

public final class ChoroplethOptions
extends ScalesOptions

Specific options for choropleth chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
protected void	afterAxisConfigurationUpdate(Axis axis)	Invoked after the axis options has been updated.
protected void	afterConfigurationUpdate()	Invoked after the chart options has been updated.
IsChart	getChart()	Returns the chart instance
default ClipMap	getClipMap()	Returns whether to clip the rendering to the chart area of the graph.
protected T	getConfiguration()	Returns the configuration element.
ChoroplethElements	getElements()	Returns the elements element.
org.pepstock.charba.client.geo.CommonOptionsHandler	getHandler()
default List<Feature>	getOutline()	Returns the outline used to scale and centralize the projection in the chart area.
default Graticule	getShowGraticule()	Returns the graticule to render the lines in the background.
default boolean	isClipMap()	Returns whether to clip the rendering to the chart area of the graph.
default boolean	isShowGraticule()	Returns true to render a graticule in the background.
default boolean	isShowOutline()	Returns true to render the outline in the background.
ChartEnvelop<NativeObject>	loadNativeObject(ChartEnvelop<NativeObject> envelop)	Returns the native object instance inside an envelop. It can be called only from org.pepstock.charba.client package.
void	merge(NativeObjectContainer source, String property)	Merge a native object in the this one with a specific property name. This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.
default void	setClipMap(boolean clipMap)	Sets whether to clip the rendering to the chart area of the graph.
default void	setClipMap(ClipMap clipMap)	Sets whether to clip the rendering to the chart area of the graph.
protected void	setConfiguration(T configuration)
default void	setOutline(List<Feature> outline)	Sets the outline used to scale and centralize the projection in the chart area.
default void	setOutline(Feature... outline)	Sets the outline used to scale and centralize the projection in the chart area.
default void	setShowGraticule(boolean showGraticule)	Sets true to render the lines in the background.
default void	setShowGraticule(Graticule showGraticule)	Sets the graticule object to render the lines in the background.
default void	setShowOutline(boolean showOutline)	Sets true to render the outline in the background.
String	toJSON()	Returns the JSON representation of the object.

Methods inherited from class org.pepstock.charba.client.configuration.ScalesOptions

getAxisById, getScales

Methods inherited from class org.pepstock.charba.client.configuration.ConfigurationOptions

beforeAxisConfigurationUpdate, beforeConfigurationUpdate, getAnimationContainer, getAspectRatio, getBackgroundColor, getBackgroundColorAsString, getBorderColor, getBorderColorAsString, getColor, getColorAsString, getDatasets, getDevicePixelRatio, getEvents, getFiller, getFont, getHover, getInteraction, getLayout, getLegend, getLocale, getPlugins, getResizeDelay, getSubtitle, getTitle, getTooltips, hasAxisClickHandlers, hasAxisEnterHandlers, hasAxisHoverHandlers, hasAxisLeaveHandlers, hasDatasetSelectionHandlers, hasSubtitleClickHandlers, hasSubtitleEnterHandlers, hasSubtitleLeaveHandlers, hasTitleClickHandlers, hasTitleEnterHandlers, hasTitleLeaveHandlers, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, load, loadOptions, onAdd, onRemove, setAspectRatio, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setChartOptions, setColor, setColor, setDestroyOnDetach, setDevicePixelRatio, setDrawOnAttach, setEvents, setLocale, setMaintainAspectRatio, setResizeDelay, setResponsive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.configuration.HasAnimation

getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled

Method Detail

afterConfigurationUpdate

protected final void afterConfigurationUpdate()

Description copied from class: ConfigurationOptions

Invoked after the chart options has been updated.

Overrides:

afterConfigurationUpdate in class ConfigurationOptions

afterAxisConfigurationUpdate

protected void afterAxisConfigurationUpdate(Axis axis)

Description copied from class: ConfigurationOptions

Invoked after the axis options has been updated.

Overrides:

afterAxisConfigurationUpdate in class ConfigurationOptions

Parameters:

axis - axis instance which has been updated

getHandler

public org.pepstock.charba.client.geo.CommonOptionsHandler getHandler()

getElements

public ChoroplethElements getElements()

Description copied from class: ConfigurationOptions

Returns the elements element.

Overrides:

getElements in class ConfigurationOptions

Returns:

the elements

setOutline

public default void setOutline(Feature... outline)

Sets the outline used to scale and centralize the projection in the chart area. By default a sphere is used.

Parameters:

outline - the outline used to scale and centralize the projection in the chart area

setOutline

public default void setOutline(List<Feature> outline)

Sets the outline used to scale and centralize the projection in the chart area. By default a sphere is used.

Parameters:

outline - the outline used to scale and centralize the projection in the chart area

getOutline

public default List<Feature> getOutline()

Returns the outline used to scale and centralize the projection in the chart area. By default a sphere is used.

Returns:

the outline used to scale and centralize the projection in the chart area

setShowOutline

public default void setShowOutline(boolean showOutline)

Sets true to render the outline in the background.

Parameters:

showOutline - true to render the outline in the background

isShowOutline

public default boolean isShowOutline()

Returns true to render the outline in the background.

Returns:

true to render the outline in the background

setShowGraticule

public default void setShowGraticule(boolean showGraticule)

Sets true to render the lines in the background.

Parameters:

showGraticule - true to render the lines in the background

setShowGraticule

public default void setShowGraticule(Graticule showGraticule)

Sets the graticule object to render the lines in the background.

Parameters:

showGraticule - the graticule to render the lines in the background

isShowGraticule

public default boolean isShowGraticule()

Returns true to render a graticule in the background.

Returns:

true to render a graticule in the background

getShowGraticule

public default Graticule getShowGraticule()

Returns the graticule to render the lines in the background.

Returns:

the graticule to render the lines in the background or null is any object has been set

setClipMap

public default void setClipMap(ClipMap clipMap)

Sets whether to clip the rendering to the chart area of the graph.

Parameters:

clipMap - whether to clip the rendering to the chart area of the graph

getClipMap

public default ClipMap getClipMap()

Returns whether to clip the rendering to the chart area of the graph.

Returns:

whether to clip the rendering to the chart area of the graph

setClipMap

public default void setClipMap(boolean clipMap)

Sets whether to clip the rendering to the chart area of the graph.

Parameters:

clipMap - whether to clip the rendering to the chart area of the graph

isClipMap

public default boolean isClipMap()

Returns whether to clip the rendering to the chart area of the graph.

Returns:

whether to clip the rendering to the chart area of the graph

setConfiguration

protected final void setConfiguration(T configuration)

Parameters:

configuration - the configuration to set

getConfiguration

protected final T getConfiguration()

Returns the configuration element.

Returns:

the configuration element.

merge

public final void merge(NativeObjectContainer source,
                        String property)

Merge a native object in the this one with a specific property name.
This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.

Parameters:

source - native object container to add

property - property name

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

loadNativeObject

public final ChartEnvelop<NativeObject> loadNativeObject(ChartEnvelop<NativeObject> envelop)

Returns the native object instance inside an envelop.
It can be called only from org.pepstock.charba.client package.

Parameters:

envelop - envelop instance which will contain the native object

Returns:

the envelop, passed as argument, loaded with the native object

getChart

public final IsChart getChart()

Returns the chart instance

Returns:

the chart