org.pepstock.charba.client.geo

Class ChoroplethDataset

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.data.Dataset

org.pepstock.charba.client.data.HoverFlexDataset

org.pepstock.charba.client.data.BarDataset

org.pepstock.charba.client.geo.ChoroplethDataset

All Implemented Interfaces:

HasCallbackScope, HasDataPoints, HasDataset, IsDefaultAnimationContainer, IsDefaultAnimationTransition, IsDefaultBarDatasets, HasAnimationOptions, HasBarDatasetOptions

public final class ChoroplethDataset
extends BarDataset

The choropleth data set allows a region definition (by Feature) and specific value to be specified.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested classes/interfaces inherited from class org.pepstock.charba.client.data.Dataset

Dataset.CanvasObjectProperty, Dataset.CommonProperty

Field Summary

Fields inherited from class org.pepstock.charba.client.data.BarDataset

FLOATING_BAR_DATA_FACTORY

Fields inherited from class org.pepstock.charba.client.data.Dataset

DEFAULT_HIDDEN, DEFAULT_NORMALIZED, DEFAULT_PARSING

Constructor Summary

Constructors

Constructor and Description
ChoroplethDataset() Creates a data set. It uses the global options has default.
ChoroplethDataset(IsDefaultOptions defaultValues) Creates a data set setting the defaults value.

Method Summary

Modifier and Type	Method and Description
default ClipMap	getClipMap() Returns whether to clip the rendering to the chart area of the graph.
List<Double>	getData(boolean binding) Throws an exception because not available.
org.pepstock.charba.client.geo.GeoDatasetHandler<ChoroplethDataPoint>	getHandler() Returns the data set options handler.
default int	getOrder() Returns the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
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 List<T>	getValues() Returns the data property of a data set for a chart is specified as an array of GeoDataPoint.
default List<T>	getValues(boolean binding) Returns the data property of a data set for a chart is specified as an array of GeoDataPoint.
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.
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.
void	setData(double... values) Throws an exception because not available.
void	setData(List<Double> values) Throws an exception because not available.
default void	setOrder(int order) Sets the drawing order of dataset. Also affects order for stacking, tooltip, and legend.
default void	setOutline(Feature... outline) Sets the outline used to scale and centralize the projection in the chart area.
default void	setOutline(List<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.
default void	setValues(List<T> values) Sets the data property of a data set for a chart is specified as an array of GeoDataPoint.
default void	setValues(T[] values) Sets the data property of a data set for a chart is specified as an array of GeoDataPoint.

Methods inherited from class org.pepstock.charba.client.data.BarDataset

getBase, getBaseCallback, getBorderRadius, getBorderRadiusAsObjects, getBorderRadiusCallback, getBorderSkipped, getBorderSkippedCallback, getBorderWidth, getBorderWidthAsObjects, getBorderWidthCallback, getDatasetOptionsHandler, getDefaultBackgroundColorAsString, getDefaultBorderColorAsString, getDefaultBorderWidth, getDefaultHoverBackgroundColorAsString, getDefaultHoverBorderColorAsString, getDefaultHoverBorderWidth, getEnableBorderRadiusCallback, getFloatingData, getFloatingData, getHoverBorderRadius, getHoverBorderRadiusAsObjects, getHoverBorderRadiusCallback, getHoverBorderWidth, getHoverBorderWidthAsObjects, getHoverBorderWidthCallback, getIndexAxis, getLabel, getOrderHandler, getPointStyle, getPointStyleAsCanvas, getPointStyleAsImage, getPointStyleCallback, getPointStyleType, getXAxisID, getYAxisID, isEnableBorderRadius, setBase, setBase, setBase, setBorderRadius, setBorderRadius, setBorderRadius, setBorderRadius, setBorderRadius, setBorderSkipped, setBorderSkipped, setBorderSkipped, setBorderSkipped, setBorderSkipped, setBorderWidth, setBorderWidth, setBorderWidth, setBorderWidth, setBorderWidth, setEnableBorderRadius, setEnableBorderRadius, setEnableBorderRadius, setFloatingData, setFloatingData, setFloatingData, setHoverBorderRadius, setHoverBorderRadius, setHoverBorderRadius, setHoverBorderRadius, setHoverBorderRadius, setHoverBorderWidth, setHoverBorderWidth, setHoverBorderWidth, setHoverBorderWidth, setHoverBorderWidth, setIndexAxis, setPointStyle, setPointStyle, setPointStyle, setPointStyle, setPointStyle, setXAxisID, setXAxisID, setYAxisID, setYAxisID

Methods inherited from class org.pepstock.charba.client.data.HoverFlexDataset

getBackgroundColor, getBackgroundColorAsGradient, getBackgroundColorAsPatterns, getBackgroundColorAsString, getBorderColor, getBorderColorAsGradient, getBorderColorAsString, getColors, getHoverBackgroundColor, getHoverBackgroundColorAsGradient, getHoverBackgroundColorAsPatterns, getHoverBackgroundColorAsString, getHoverBorderColor, getHoverBorderColorAsGradient, getHoverBorderColorAsString, getWidths, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderColor, setColors, setColors, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setHoverBorderColor, setWidths

Methods inherited from class org.pepstock.charba.client.data.Dataset

createContext, getAnimationContainer, getBackgroundColorCallback, getBorderColorCallback, getClip, getClipAsObject, getData, getDataCount, getDataset, getDataType, getDefaultValues, getHoverBackgroundColorCallback, getHoverBorderColorCallback, getId, getOptions, getOptions, getScope, getType, getTypedDataset, hasOptions, invokeColorCallback, isClip, isHidden, isNormalized, isParsing, removeOptions, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setClip, setClip, setClip, setHidden, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setLabel, setNormalized, setOptions, setOptions, setParsing

Methods inherited from class org.pepstock.charba.client.commons.AbstractNode

checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

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.data.HasDataPoints

getDataPoints, getDataPoints, setDataPoints, setDataPoints

Methods inherited from interface org.pepstock.charba.client.data.HasDataset

getDataset

Methods inherited from interface org.pepstock.charba.client.options.HasBarDatasetOptions

getBarPercentage, getBarThickness, getCategoryPercentage, getMaxBarThickness, getMinBarLength, isGrouped, setBarPercentage, setBarThickness, setCategoryPercentage, setGrouped, setMaxBarThickness, setMinBarLength

Methods inherited from interface org.pepstock.charba.client.options.HasAnimationOptions

getAnimation, getAnimations, getTransitions, isAnimationEnabled, setAnimationEnabled

Methods inherited from interface org.pepstock.charba.client.commons.HasCallbackScope

extractScope

Constructor Detail

ChoroplethDataset

public ChoroplethDataset()

Creates a data set.
It uses the global options has default.

ChoroplethDataset

public ChoroplethDataset(IsDefaultOptions defaultValues)

Creates a data set setting the defaults value.

Parameters:

defaultValues - default options

Method Detail

getHandler

public org.pepstock.charba.client.geo.GeoDatasetHandler<ChoroplethDataPoint> getHandler()

Returns the data set options handler.

Returns:

the data set options handler

setData

public void setData(double... values)

Throws an exception because not available.

Overrides:

setData in class Dataset

Parameters:

values - ignored because will throw an exception

setData

public void setData(List<Double> values)

Throws an exception because not available.

Overrides:

setData in class Dataset

Parameters:

values - ignored because will throw an exception

getData

public List<Double> getData(boolean binding)

Throws an exception because not available.

Overrides:

getData in class Dataset

Parameters:

binding - ignored because will throw an exception

Returns:

nothing because will throw an exception

setValues

public void setValues(T[] values)

Sets the data property of a data set for a chart is specified as an array of GeoDataPoint.

Parameters:

values - an array of GeoDataPoint

setValues

public void setValues(List<T> values)

Sets the data property of a data set for a chart is specified as an array of GeoDataPoint.

Parameters:

values - an array of GeoDataPoint

getValues

public List<T> getValues()

Returns the data property of a data set for a chart is specified as an array of GeoDataPoint.

Returns:

list of GeoDataPoint.

getValues

public List<T> getValues(boolean binding)

Returns the data property of a data set for a chart is specified as an array of GeoDataPoint.

Parameters:

binding - if true binds the new array list in the container

Returns:

list of GeoDataPoint.

setOutline

public 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 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 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 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 boolean isShowOutline()

Returns true to render the outline in the background.

Returns:

true to render the outline in the background

setShowGraticule

public 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 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 boolean isShowGraticule()

Returns true to render a graticule in the background.

Returns:

true to render a graticule in the background

getShowGraticule

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

setOrder

public void setOrder(int order)

Sets the drawing order of dataset.
Also affects order for stacking, tooltip, and legend.

Parameters:

order - the drawing order of dataset.

getOrder

public int getOrder()

Returns the drawing order of dataset.
Also affects order for stacking, tooltip, and legend.

Returns:

the drawing order of dataset