Package org.pepstock.charba.client.treemap

Class TreeMapChart

java.lang.Object

org.pepstock.charba.client.events.HandlerManager

org.pepstock.charba.client.AbstractChart

org.pepstock.charba.client.treemap.TreeMapChart

All Implemented Interfaces:

HasAxes, IsChart, IsDatasetCreator<TreeMapDataset>

public final class TreeMapChart
extends AbstractChart
implements IsDatasetCreator<TreeMapDataset>

A treemap chart is used for displaying hierarchical data using nested rectangles.
Treemaps display hierarchical (tree-structured) data as a set of nested rectangles.
Each branch of the tree is given a rectangle, which is then tiled with smaller rectangles representing sub-branches.
A leaf node's rectangle has an area proportional to a specified dimension of the data.
When the color and size dimensions are correlated in some way with the tree structure, one can often easily see patterns that would be difficult to spot in other ways, such as whether a certain color is particularly relevant.
A second advantage of treemaps is that, by construction, they make efficient use of space. As a result, they can legibly display thousands of items on the screen simultaneously.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

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

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

datasetReferenceFactory

Constructor Summary

Constructors

Constructor	Description
TreeMapChart()	Builds the object.

Method Summary

Modifier and Type	Method	Description
protected void	applyConfiguration()	Called before any drawing or reconfiguration in order that the chart which implements it can override options
protected boolean	checkDataset(Dataset dataset)	Returns true if the dataset can be managed by a this chart type.
protected int	getMaximumDatasetsCount()	Returns the maximum amount of datasets that the chart can manage.
TreeMapOptions	getOptions()	Returns the options of chart.
TreeMapDataset	newDataset(boolean hidden)	Creates a new dataset related to chart type.
static void	register()	Registers the TREEMAP controller in CHART.JS.

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

addHandler, checkAxes, checkDatasets, clear, createAndSetTimer, destroy, draw, getActiveElements, getBaseType, getCanvas, getChartElement, getData, getDatasetAtEvent, getDatasetItem, getDatasetReferenceFactory, getDefaultChartOptions, getDrawCount, getElementAtEvent, getElementAtEvent, getElementsAtEvent, getElementsAtEvent, getId, getInitialCursor, getMaximumAxesCount, getNode, getPlugins, getSource, getTimer, getTooltipActiveElements, getType, getVisibleDatasetCount, getWholeOptions, hide, hide, isChartAttached, isDatasetVisible, isDataVisible, isDestroyOnDetach, isDrawOnAttach, isInitialized, isPluginEnabled, onAttach, onDetach, reconfigure, reconfigure, reconfigure, removeCanvasPreventDefault, render, reset, resetActiveElements, resetTooltipActiveElements, resize, resize, setActiveElements, setActiveElements, setDatasetVisibility, setDestroyOnDetach, setDrawOnAttach, setTooltipActiveElements, setTooltipActiveElements, 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.HasAxes

checkAxis

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

fireEvent, getHandlerCount, isEventHandled, toBase64Image, toBase64Image, toBase64Image

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

newDataset

Field Detail

TYPE

public static final String TYPE

Name of chart type "treemap"

See Also:

Constant Field Values

CONTROLLER_TYPE

public static final ControllerType CONTROLLER_TYPE

TreeMap controller type.

Constructor Detail

TreeMapChart

public TreeMapChart()

Builds the object.

Method Detail

getOptions

public TreeMapOptions getOptions()

Description copied from interface: IsChart

Returns the options of chart.

Specified by:

getOptions in interface IsChart

Returns:

the options of chart.

newDataset

public TreeMapDataset newDataset(boolean hidden)

Description copied from interface: IsDatasetCreator

Creates a new dataset related to chart type.

Specified by:

newDataset in interface IsDatasetCreator<TreeMapDataset>

Parameters:

hidden - if true, it will be initially hidden.

Returns:

a new dataset related to chart type.

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

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

register

public static void register()

Registers the TREEMAP controller in CHART.JS.