Package org.pepstock.charba.client.gwt.widgets

Class SankeyChartWidget

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.SimplePanel

org.pepstock.charba.client.gwt.widgets.AbstractChartWidget<SankeyChart>

org.pepstock.charba.client.gwt.widgets.SankeyChartWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, IsChart, IsDatasetCreator<SankeyDataset>

public class SankeyChartWidget
extends AbstractChartWidget<SankeyChart>
implements IsDatasetCreator<SankeyDataset>

Sankey charts are a type of flow diagram in which the width of the arrows is proportional to the flow rate.
Sankey diagrams emphasize the major transfers or flows within a system.
They help locate the most important contributions to a flow.
They often show conserved quantities within defined system boundaries.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
	SankeyChartWidget()	Builds the object.
protected	SankeyChartWidget(SankeyChart extendedChart)	Builds the chart. This is must be extended for controller which are based on this chart.

Method Summary

Modifier and Type	Method	Description
SankeyOptions	getOptions()	Returns the options of chart.
SankeyDataset	newDataset(boolean hidden)	Creates a new dataset related to chart type.
static void	register()	Registers the SANKEY controller in CHART.JS.

Methods inherited from class org.pepstock.charba.client.gwt.widgets.AbstractChartWidget

addHandler, checkAxes, checkDatasets, createAndSetTimer, destroy, draw, fireEvent, getActiveElements, getBaseType, getCanvas, getChart, getChartElement, getData, getDatasetAtEvent, getDatasetItem, getDatasetReferenceFactory, getDefaultChartOptions, getDrawCount, getElementAtEvent, getElementAtEvent, getElementsAtEvent, getElementsAtEvent, getHandlerCount, getId, getInitialCursor, getNode, getPlugins, getTimer, getTooltipActiveElements, getType, getVisibleDatasetCount, getWholeOptions, hide, hide, isChartAttached, isDatasetVisible, isDataVisible, isDestroyOnDetach, isDrawOnAttach, isEventHandled, isInitialized, 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 com.google.gwt.user.client.ui.SimplePanel

add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

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

clear, toBase64Image, toBase64Image, toBase64Image

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

newDataset

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SankeyChartWidget

public SankeyChartWidget()

Builds the object.

SankeyChartWidget

protected SankeyChartWidget(SankeyChart extendedChart)

Builds the chart.
This is must be extended for controller which are based on this chart.

Parameters:

extendedChart - new chart

Method Detail

getOptions

public SankeyOptions getOptions()

Description copied from interface: IsChart

Returns the options of chart.

Specified by:

getOptions in interface IsChart

Returns:

the options of chart.

newDataset

public SankeyDataset newDataset(boolean hidden)

Description copied from interface: IsDatasetCreator

Creates a new dataset related to chart type.

Specified by:

newDataset in interface IsDatasetCreator<SankeyDataset>

Parameters:

hidden - if true, it will be initially hidden.

Returns:

a new dataset related to chart type.

register

public static void register()

Registers the SANKEY controller in CHART.JS.