org.pepstock.charba.client.geo

Class ChoroplethChart

java.lang.Object

org.pepstock.charba.client.events.HandlerManager

org.pepstock.charba.client.AbstractChart

org.pepstock.charba.client.geo.ChoroplethChart

All Implemented Interfaces:

HasAxes, IsChart, IsDatasetCreator<ChoroplethDataset>

public final class ChoroplethChart
extends AbstractChart

A choropleth chart is used to render maps with the area filled according to some numerical value.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static ControllerType	CONTROLLER_TYPE Choropleth controller type.
static String	TYPE Name of chart type "choropleth"

Constructor Summary

Constructors

Constructor and Description
ChoroplethChart() Builds the object.

Method Summary

Modifier and Type	Method and Description
protected void	applyConfiguration() Called before any drawing or reconfiguration in order that the chart which implements it can override options
void	checkAxes(Axis... axes) Checks if axes, requested to be stored, are an acceptable type or amount. If a axis type or the amount of axes are not consistent for the chart, a IllegalArgumentException will be thrown.
boolean	checkAxis(Axis axis) Returns true if the axis can be managed by a this chart type.
protected boolean	checkDataset(Dataset dataset) Returns true if the dataset can be managed by a this chart type.
protected int	getMaximumAxesCount() Returns the maximum amount of axes that the chart can manage.
protected int	getMaximumDatasetsCount() Returns the maximum amount of datasets that the chart can manage.
ChoroplethOptions	getOptions() Returns the options of chart.
ChoroplethDataset	newDataset(boolean hidden) Creates a new dataset related to chart type.

Methods inherited from class org.pepstock.charba.client.AbstractChart

addHandler, checkDatasets, clear, createAndSetTimer, destroy, draw, getActiveElements, getBaseType, getCanvas, getChartElement, getData, getDatasetAtEvent, getDatasetItem, getDefaultChartOptions, getElementAtEvent, getElementsAtEvent, getId, getInitialCursor, getNode, getPlugins, getSource, getTimer, getTooltipActiveElements, getType, getVisibleDatasetCount, getWholeOptions, hide, hide, isChartAttached, isDatasetVisible, isDataVisible, isDestroyOnDetach, isDrawOnAttach, isInitialized, onAttach, onDetach, reconfigure, reconfigure, reconfigure, removeCanvasPreventDefault, render, reset, resetActiveElements, resetTooltipActiveElements, resize, resize, setActiveElements, setActiveElements, setDatasetVisibility, setDestroyOnDetach, setDrawOnAttach, setTooltipActiveElements, setTooltipActiveElements, show, show, stop, toBase64Image, toggleDataVisibility, update, update, update

Methods inherited from class org.pepstock.charba.client.events.HandlerManager

fireEvent, getHandlerCount, isEventHandled

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.IsDatasetCreator

newDataset

Methods inherited from interface org.pepstock.charba.client.IsChart

checkAndGetIfConsistent, checkAndGetIfValid, checkIfConsistent, checkIfValid, fireEvent, getHandlerCount, isAbstractChart, isConsistent, isEventHandled, isValid, toBase64Image, toBase64Image, toBase64Image

Field Detail

TYPE

public static final String TYPE

Name of chart type "choropleth"

See Also:

Constant Field Values

CONTROLLER_TYPE

public static final ControllerType CONTROLLER_TYPE

Choropleth controller type.

Constructor Detail

ChoroplethChart

public ChoroplethChart()

Builds the object.

Method Detail

getOptions

public ChoroplethOptions getOptions()

Description copied from interface: IsChart

Returns the options of chart.

Returns:

the options of chart.

newDataset

public ChoroplethDataset newDataset(boolean hidden)

Description copied from interface: IsDatasetCreator

Creates a new dataset related to chart type.

Parameters:

hidden - if true, it will be initially hidden.

Returns:

a new dataset related to chart type.

checkDataset

protected boolean checkDataset(Dataset dataset)

Description copied from class: AbstractChart

Returns true if the dataset can be managed by a this chart type.

Specified by:

checkDataset in class AbstractChart

Parameters:

dataset - dataset to check

Returns:

true if the dataset can be managed by a this chart type

checkAxis

public boolean checkAxis(Axis axis)

Description copied from interface: HasAxes

Returns true if the axis can be managed by a this chart type.

Parameters:

axis - axis to check

Returns:

true if the axis can be managed by a this chart type

checkAxes

public void checkAxes(Axis... axes)

Description copied from interface: IsChart

Checks if axes, requested to be stored, are an acceptable type or amount.
If a axis type or the amount of axes are not consistent for the chart, a IllegalArgumentException will be thrown.

Specified by:

checkAxes in interface IsChart

Overrides:

checkAxes in class AbstractChart

Parameters:

axes - list of axes to check.

applyConfiguration

protected final void applyConfiguration()

Description copied from class: AbstractChart

Called before any drawing or reconfiguration in order that the chart which implements it can override options

Overrides:

applyConfiguration in class AbstractChart

getMaximumDatasetsCount

protected final int getMaximumDatasetsCount()

Description copied from class: AbstractChart

Returns the maximum amount of datasets that the chart can manage.

Overrides:

getMaximumDatasetsCount in class AbstractChart

Returns:

the maximum amount of datasets that the chart can manage.

getMaximumAxesCount

protected final int getMaximumAxesCount()

Description copied from class: AbstractChart

Returns the maximum amount of axes that the chart can manage.

Overrides:

getMaximumAxesCount in class AbstractChart

Returns:

the maximum amount of axes that the chart can manage.