org.pepstock.charba.client.options

Class Legend

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractModel<Options,IsDefaultLegend>

org.pepstock.charba.client.options.Legend

All Implemented Interfaces:

IsDefaultLegend

public final class Legend
extends AbstractModel<Options,IsDefaultLegend>
implements IsDefaultLegend

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() Returns the legend labels element.
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.options.AbstractModel

checkAndAddToParent, getChildKey, getDefaultValues, getParent, setCallbackToModel, setEventToModel

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

getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, 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

getLabels

public LegendLabels getLabels()

Returns the legend labels element.

Specified by:

getLabels in interface IsDefaultLegend

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.

Specified by:

isDisplay in interface IsDefaultLegend

Returns:

true if the legend is shown.

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)

Specified by:

isFullWidth in interface IsDefaultLegend

Returns:

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

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.

Specified by:

isReverse in interface IsDefaultLegend

Returns:

true if legend will show datasets in reverse order.

setPosition

public void setPosition(Position position)

Sets the position of the legend.

Parameters:

position - Position of the legend.

getPosition

public Position getPosition()

Returns the position of the legend.

Specified by:

getPosition in interface IsDefaultLegend

Returns:

position of the legend.