Package org.pepstock.charba.client.sankey

Class SankeyElementOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.items.ChartElementOptions

org.pepstock.charba.client.sankey.SankeyElementOptions

public final class SankeyElementOptions
extends ChartElementOptions

Maps the out-of-the-box CHART.JS element options used to represents flows on the charts.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field	Description
static ElementFactory<SankeyElementOptions>	FACTORY	Element factory to get ""flow"" element.

Method Summary

Modifier and Type	Method	Description
IsColor	getColorFrom()	Returns the starting color of the flow between sankey elements.
String	getColorFromAsString()	Returns the starting color of the flow between sankey elements.
ColorMode	getColorMode()	Returns the color mode between sankey elements.
IsColor	getColorTo()	Returns the ending color of the flow between sankey elements.
String	getColorToAsString()	Returns the ending color of the flow between sankey elements.
IsColor	getHoverColorFrom()	Returns the starting color of the flow between sankey elements, when hovered.
String	getHoverColorFromAsString()	Returns the starting color of the flow between sankey elements, when hovered.
IsColor	getHoverColorTo()	Returns the ending color of the flow between sankey elements, when hovered.
String	getHoverColorToAsString()	Returns the ending color of the flow between sankey elements, when hovered.
void	setColorFrom(String color)	Sets the starting color of the flow between sankey elements.
void	setColorFrom(IsColor color)	Sets the starting color of the flow between sankey elements.
void	setColorMode(ColorMode colorMode)	Sets the color mode between sankey elements.
void	setColorTo(String color)	Sets the ending color of the flow between sankey elements.
void	setColorTo(IsColor color)	Sets the ending color of the flow between sankey elements.
void	setHoverColorFrom(String color)	Sets the starting color of the flow between sankey elements, when hovered.
void	setHoverColorFrom(IsColor color)	Sets the starting color of the flow between sankey elements, when hovered.
void	setHoverColorTo(String color)	Sets the ending color of the flow between sankey elements, when hovered.
void	setHoverColorTo(IsColor color)	Sets the ending color of the flow between sankey elements, when hovered.

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

Field Detail

FACTORY

public static final ElementFactory<SankeyElementOptions> FACTORY

Element factory to get ""flow"" element.

Method Detail

getColorMode

public ColorMode getColorMode()

Returns the color mode between sankey elements.

Returns:

the color mode between sankey elements

setColorMode

public void setColorMode(ColorMode colorMode)

Sets the color mode between sankey elements.

Parameters:

colorMode - the color mode between sankey elements

getColorFromAsString

public String getColorFromAsString()

Returns the starting color of the flow between sankey elements.

Returns:

the starting color of the flow between sankey elements

getColorFrom

public IsColor getColorFrom()

Returns the starting color of the flow between sankey elements.

Returns:

the starting color of the flow between sankey elements

setColorFrom

public void setColorFrom(IsColor color)

Sets the starting color of the flow between sankey elements.

Parameters:

color - the starting color of the flow between sankey elements

setColorFrom

public void setColorFrom(String color)

Sets the starting color of the flow between sankey elements.

Parameters:

color - the starting color of the flow between sankey elements

getColorToAsString

public String getColorToAsString()

Returns the ending color of the flow between sankey elements.

Returns:

the ending color of the flow between sankey elements

getColorTo

public IsColor getColorTo()

Returns the ending color of the flow between sankey elements.

Returns:

the ending color of the flow between sankey elements

setColorTo

public void setColorTo(IsColor color)

Sets the ending color of the flow between sankey elements.

Parameters:

color - the ending color of the flow between sankey elements

setColorTo

public void setColorTo(String color)

Sets the ending color of the flow between sankey elements.

Parameters:

color - the ending color of the flow between sankey elements

getHoverColorFromAsString

public String getHoverColorFromAsString()

Returns the starting color of the flow between sankey elements, when hovered.

Returns:

the starting color of the flow between sankey elements, when hovered

getHoverColorFrom

public IsColor getHoverColorFrom()

Returns the starting color of the flow between sankey elements, when hovered.

Returns:

the starting color of the flow between sankey elements, when hovered

setHoverColorFrom

public void setHoverColorFrom(IsColor color)

Sets the starting color of the flow between sankey elements, when hovered.

Parameters:

color - the starting color of the flow between sankey elements, when hovered

setHoverColorFrom

public void setHoverColorFrom(String color)

Sets the starting color of the flow between sankey elements, when hovered.

Parameters:

color - the starting color of the flow between sankey elements, when hovered

getHoverColorToAsString

public String getHoverColorToAsString()

Returns the ending color of the flow between sankey elements, when hovered.

Returns:

the ending color of the flow between sankey elements, when hovered

getHoverColorTo

public IsColor getHoverColorTo()

Returns the ending color of the flow between sankey elements, when hovered.

Returns:

the ending color of the flow between sankey elements, when hovered

setHoverColorTo

public void setHoverColorTo(IsColor color)

Sets the ending color of the flow between sankey elements, when hovered.

Parameters:

color - the ending color of the flow between sankey elements, when hovered

setHoverColorTo

public void setHoverColorTo(String color)

Sets the ending color of the flow between sankey elements, when hovered.

Parameters:

color - the ending color of the flow between sankey elements, when hovered