org.pepstock.charba.client.datalabels

Class Labels

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.datalabels.Labels

public final class Labels
extends NativeObjectContainer

Base object to map multi labels options for DataLabelsPlugin.ID plugin configuration.
It's possible to define multiple labels for each data element using the this object.
It is an object where each property represents a new label, the key being the label key and the value being the options specific to each label.
These options are merged on top of the options defined at the chart and dataset levels.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
DataLabelsOptions	getLabel(Key key) Returns the stored options for specific key.
DataLabelsOptions	getLabel(String key) Returns the stored options for specific key.
List<Key>	getLabelKeys() Returns the list of all keys related to stored options.
boolean	hasLabel(Key key) Returns true if there is a stored options for specific key.
boolean	hasLabel(String key) Returns true if there is a stored options for specific key.
void	setLabel(Key key, DataLabelsOptions options) Sets new data labels options with a specific key.
void	setLabel(String key, DataLabelsOptions options) Sets new data labels options with a specific key.

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, 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

Method Detail

setLabel

public void setLabel(String key,
                     DataLabelsOptions options)

Sets new data labels options with a specific key.

Parameters:

key - key of the options

options - options instance

setLabel

public void setLabel(Key key,
                     DataLabelsOptions options)

Sets new data labels options with a specific key.

Parameters:

key - key of the options

options - options instance

getLabel

public DataLabelsOptions getLabel(String key)

Returns the stored options for specific key.

Parameters:

key - key of the options

Returns:

the stored option or null if no options are stored for that key

getLabel

public DataLabelsOptions getLabel(Key key)

Returns the stored options for specific key.

Parameters:

key - key of the options

Returns:

the stored option or null if no options are stored for that key

hasLabel

public boolean hasLabel(String key)

Returns true if there is a stored options for specific key.

Parameters:

key - key of the options

Returns:

true if there is a stored options for specific key

hasLabel

public boolean hasLabel(Key key)

Returns true if there is a stored options for specific key.

Parameters:

key - key of the options

Returns:

true if there is a stored options for specific key

getLabelKeys

public List<Key> getLabelKeys()

Returns the list of all keys related to stored options.

Returns:

the list of all keys related to stored options