Legend (Charba - GWT Charts library based on CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.options.Legend

All Implemented Interfaces:

IsDefaultLegend, IsDefaultTextDirectioner
```
public final class Legend
extends NativeObjectContainer
implements IsDefaultLegend
```
The chart legend displays data about the datasets that area appearing on the chart.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`protected void`	`checkAndAddToParent()` Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
`LegendAlign`	`getAlign()` Returns the alignment of the legend.
`protected Key`	`getChildKey()` Returns the property name to use to add this element to its parent.
`protected D`	`getDefaultValues()` Returns the default provider instance.
`LegendLabels`	`getLabels()` Returns the legend labels element.
`protected P`	`getParent()` Returns the parent element.
`Position`	`getPosition()` Returns the position of the legend.
`default TextDirection`	`getTextDirection()` Returns the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas.
`org.pepstock.charba.client.options.TextDirectioner`	`getTextDirectioner()` Returns a text directioner instance to use into default methods of this interface.
`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.
`default boolean`	`isRtl()` Returns `true` for rendering the object from right to left.
`void`	`setAlign(LegendAlign alignment)` Sets the alignment of the legend.
`protected void`	`setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for callbacks) to a model at the specific key.
`void`	`setDisplay(boolean display)` Sets if the legend is shown.
`protected void`	`setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy)` Adds a proxy function (for events) to a model at the specific key.
`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.
`default void`	`setRtl(boolean rtl)` Sets `true` for rendering the tooltips from right to left.
`default void`	`setTextDirection(TextDirection textDirection)` Sets the text direction of the tooltips that will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas.

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
  - getTextDirectioner
```
public org.pepstock.charba.client.options.TextDirectioner getTextDirectioner()
```
    Returns a text directioner instance to use into default methods of this interface.
    
    Returns:
    
    a text directioner instance
  - 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.
  - setAlign
```
public void setAlign(LegendAlign alignment)
```
    Sets the alignment of the legend.
    
    Parameters:
    
    alignment - alignment of the legend.
  - getAlign
```
public LegendAlign getAlign()
```
    Returns the alignment of the legend.
    
    Specified by:
    
    getAlign in interface IsDefaultLegend
    
    Returns:
    
    alignment of the legend.
  - setRtl
```
public void setRtl(boolean rtl)
```
    Sets true for rendering the tooltips from right to left.
    
    Parameters:
    
    rtl - true for rendering the tooltips from right to left
  - isRtl
```
public boolean isRtl()
```
    Description copied from interface: IsDefaultTextDirectioner
    
    Returns true for rendering the object from right to left.
    
    Specified by:
    
    isRtl in interface IsDefaultTextDirectioner
    
    Returns:
    
    true for rendering the object from right to left.
  - setTextDirection
```
public void setTextDirection(TextDirection textDirection)
```
    Sets the text direction of the tooltips that will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas.
    
    Parameters:
    
    textDirection - the text direction of the tooltips.
  - getTextDirection
```
public TextDirection getTextDirection()
```
    Description copied from interface: IsDefaultTextDirectioner
    
    Returns the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas.
    
    Specified by:
    
    getTextDirection in interface IsDefaultTextDirectioner
    
    Returns:
    
    the text direction that will force on the canvas for rendering the object, regardless of the CSS specified on the canvas
  - getChildKey
```
protected final Key getChildKey()
```
    Returns the property name to use to add this element to its parent.
    
    Returns:
    
    the childKey or null if is a root element.
  - getParent
```
protected final P getParent()
```
    Returns the parent element.
    
    Returns:
    
    the parent or null if is a root element.
  - getDefaultValues
```
protected final D getDefaultValues()
```
    Returns the default provider instance.
    
    Returns:
    
    the default provider instance.
  - setEventToModel
```
protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for events) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - setCallbackToModel
```
protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)
```
    Adds a proxy function (for callbacks) to a model at the specific key.
    
    Parameters:
    
    model - element where adding the function proxy
    
    key - property name to use to add the function proxy
    
    proxy - the function proxy instance to add
  - checkAndAddToParent
```
protected final void checkAndAddToParent()
```
    Called recursively when a property has been set in the item.
    This is mandatory because it could happen that the parent item is not present, therefore it must be added.

Class Legend

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getTextDirectioner

getLabels

setDisplay

isDisplay

setFullWidth

isFullWidth

setReverse

isReverse

setPosition

getPosition

setAlign

getAlign

setRtl

isRtl

setTextDirection

getTextDirection

getChildKey

getParent

getDefaultValues

setEventToModel

setCallbackToModel

checkAndAddToParent