org.pepstock.charba.client.sankey

Class Labels

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.sankey.Labels

public final class Labels
extends NativeObjectContainer

Is a map to apply a different label to sankey node, node defined by SankeyDataPoint.setFrom(Key) or SankeyDataPoint.setTo(Key).

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
Labels() Creates the object with an empty native object instance.

Method Summary

Modifier and Type	Method and Description
String	get(Key nodeKey) Returns the stored value in the map, by its key of the node.
String	get(String nodeKey) Returns the stored value in the map, by its key of the node.
List<String>	getAsMultipleLines(Key nodeKey) Returns the stored value in the map, by its key of the node.
List<String>	getAsMultipleLines(String nodeKey) Returns the labels as multiple lines, by its key of the node.
boolean	isConsistent() Returns true if there is at least a key, stored in the map.
void	set(Key nodeKey, List<String> value) Sets a list of labels in the map, by its key of the node.
void	set(Key nodeKey, String value) Sets a value in the map, by its key of the node.
void	set(String nodeKey, List<String> value) Sets a list of labels in the map, by its key of the node.
void	set(String nodeKey, String value) Sets a value in the map, by its key of the node.

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

Constructor Detail

Labels

public Labels()

Creates the object with an empty native object instance.

Method Detail

isConsistent

public boolean isConsistent()

Returns true if there is at least a key, stored in the map.

Returns:

true if there is at least a key, stored in the map

set

public void set(String nodeKey,
                String value)

Sets a value in the map, by its key of the node.

Parameters:

nodeKey - the key of sankey node

value - the value to assign to the node.

set

public void set(Key nodeKey,
                String value)

Sets a value in the map, by its key of the node.

Parameters:

nodeKey - the key of sankey node

value - the value to assign to the node.

get

public String get(String nodeKey)

Returns the stored value in the map, by its key of the node.

Parameters:

nodeKey - the key of sankey node

Returns:

the value to assign to the node.

get

public String get(Key nodeKey)

Returns the stored value in the map, by its key of the node.

Parameters:

nodeKey - the key of sankey node

Returns:

the value to assign to the node.

set

public void set(String nodeKey,
                List<String> value)

Sets a list of labels in the map, by its key of the node.

Parameters:

nodeKey - the key of sankey node

value - list of labels to assign to the node.

set

public void set(Key nodeKey,
                List<String> value)

Sets a list of labels in the map, by its key of the node.

Parameters:

nodeKey - the key of sankey node

value - list of labels to assign to the node.

getAsMultipleLines

public List<String> getAsMultipleLines(String nodeKey)

Returns the labels as multiple lines, by its key of the node.

Parameters:

nodeKey - the key of sankey node

Returns:

list of labels

getAsMultipleLines

public List<String> getAsMultipleLines(Key nodeKey)

Returns the stored value in the map, by its key of the node.

Parameters:

nodeKey - the key of sankey node

Returns:

list of labels