org.pepstock.charba.client.defaults.global

Class Legend

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.defaults.AbstractItem

org.pepstock.charba.client.defaults.global.Legend

public final class Legend
extends AbstractItem

The chart legend displays data about the datasets that area appearing on the chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
LegendLabels	getLabels()
Position	getPosition() Returns the position of the legend.
boolean	isDisplay() Returns if the legend is shown.
boolean	isFullWidth() Returns if marks that this box should take the full width of the canvas (pushing down other boxes)
boolean	isReverse() Returns if the legend will show datasets in reverse order.
void	setDisplay(boolean display) Sets if the legend is shown.
void	setFullWidth(boolean fullWidth) Marks that this box should take the full width of the canvas (pushing down other boxes).
void	setPosition(Position position) Sets the position of the legend.
void	setReverse(boolean reverse) Sets the legend will show datasets in reverse order.

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

checkAndAddToParent, hasProperty

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

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

Method Detail

getLabels

public LegendLabels getLabels()

Returns:

the labels

setDisplay

public void setDisplay(boolean display)

Sets if the legend is shown.

Parameters:

display - if the legend is shown.

isDisplay

public boolean isDisplay()

Returns if the legend is shown.

Returns:

if the legend is shown. Default is true.

setFullWidth

public void setFullWidth(boolean fullWidth)

Marks that this box should take the full width of the canvas (pushing down other boxes).

Parameters:

fullWidth - Marks that this box should take the full width of the canvas (pushing down other boxes)

isFullWidth

public boolean isFullWidth()

Returns if marks that this box should take the full width of the canvas (pushing down other boxes)

Returns:

Marks that this box should take the full width of the canvas (pushing down other boxes). Default is true.

setReverse

public void setReverse(boolean reverse)

Sets the legend will show datasets in reverse order.

Parameters:

reverse - legend will show datasets in reverse order.

isReverse

public boolean isReverse()

Returns if the legend will show datasets in reverse order.

Returns:

Legend will show datasets in reverse order. Default is false.

setPosition

public void setPosition(Position position)

Sets the position of the legend.

Parameters:

position - Position of the legend.

See Also:

Position

getPosition

public Position getPosition()

Returns the position of the legend.

Returns:

Position of the legend. Default is Position.top.

See Also:

Position