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

java.lang.Object
- org.pepstock.charba.client.configuration.Legend

```
public class Legend
extends Object
```
The chart legend displays data about the datasets that area appearing on the chart.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Modifier Constructor and Description

protected Legend(Legend wrappedLegend)
Creates a legend object wrapping an existing one.

Constructors
Modifier	Constructor and Description
`protected`	`Legend(Legend wrappedLegend)` Creates a legend object wrapping an existing one.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Default Methods
Modifier and Type	Method and Description
`LegendAlign`	`getAlign()` Returns the alignment of the legend.
`IsChart`	`getChart()` Returns the chart instance
`protected T`	`getConfiguration()` Returns the configuration element.
`LegendLabels`	`getLabels()` Returns the legend labels element.
`Position`	`getPosition()` Returns the position of the legend.
`TextDirection`	`getTextDirection()` Returns the text direction of the legend that will force the text direction on the canvas for rendering the legend, regardless of the CSS specified on the canvas.
`boolean`	`hasClickHandlers()` Returns `true` if there is any legend click handler, otherwise `false`.
`boolean`	`hasHoverHandlers()` Returns `true` if there is any legend hover handler, otherwise `false`.
`boolean`	`hasLeaveHandlers()` Returns `true` if there is any legend leave handler, otherwise `false`.
`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.
`boolean`	`isRtl()` Returns `true` for rendering the legends from right to left.
`void`	`merge(NativeObjectContainer source, String property)` Merge a native object into this one with a specific property name. This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration into options of chart.
`void`	`onAdd(AddHandlerEvent event)` Invoked when a new event handler is added.
`void`	`onRemove(RemoveHandlerEvent event)` Invoked when a chart event handler is removed.
`static void`	`register(IsChart chart, org.pepstock.charba.client.configuration.IsEventProvider provider)` Adds the event provider implementation as handlers of chart.
`void`	`setAlign(LegendAlign alignment)` Sets the alignment of the legend.
`protected void`	`setConfiguration(T configuration)`
`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.
`void`	`setRtl(boolean rtl)` Sets `true` for rendering the legends from right to left.
`void`	`setTextDirection(TextDirection textDirection)` Sets the text direction of the legend that will force the text direction on the canvas for rendering the legend, regardless of the CSS specified on the canvas.
`String`	`toJSON()` Returns the JSON representation of the object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Legend
```
protected Legend(Legend wrappedLegend)
```
    Creates a legend object wrapping an existing one.
    
    Parameters:
    
    wrappedLegend - legend instance to wrap
- Method Detail
  - getLabels
```
public LegendLabels getLabels()
```
    Returns the legend labels element.
    
    Returns:
    
    the labels
  - onAdd
```
public final void onAdd(AddHandlerEvent event)
```
    Description copied from interface: AddHandlerEventHandler
    
    Invoked when a new event handler is added.
    
    Parameters:
    
    event - event to be consumed
  - onRemove
```
public final void onRemove(RemoveHandlerEvent event)
```
    Description copied from interface: RemoveHandlerEventHandler
    
    Invoked when a chart event handler is removed.
    
    Parameters:
    
    event - event to be consumed
  - hasClickHandlers
```
public final boolean hasClickHandlers()
```
    Returns true if there is any legend click handler, otherwise false.
    
    Returns:
    
    true if there is any legend click handler, otherwise false.
  - hasHoverHandlers
```
public final boolean hasHoverHandlers()
```
    Returns true if there is any legend hover handler, otherwise false.
    
    Returns:
    
    true if there is any legend hover handler, otherwise false.
  - hasLeaveHandlers
```
public final boolean hasLeaveHandlers()
```
    Returns true if there is any legend leave handler, otherwise false.
    
    Returns:
    
    true if there is any legend leave handler, otherwise false.
  - 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.
  - 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).
  - 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.
  - 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.
    
    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.
    
    Returns:
    
    alignment of the legend.
  - setRtl
```
public void setRtl(boolean rtl)
```
    Sets true for rendering the legends from right to left.
    
    Parameters:
    
    rtl - true for rendering the legends from right to left
  - isRtl
```
public boolean isRtl()
```
    Returns true for rendering the legends from right to left.
    
    Returns:
    
    true for rendering the legends from right to left.
  - setTextDirection
```
public void setTextDirection(TextDirection textDirection)
```
    Sets the text direction of the legend that will force the text direction on the canvas for rendering the legend, regardless of the CSS specified on the canvas.
    
    Parameters:
    
    textDirection - the text direction of the legend.
  - getTextDirection
```
public TextDirection getTextDirection()
```
    Returns the text direction of the legend that will force the text direction on the canvas for rendering the legend, regardless of the CSS specified on the canvas.
    
    Returns:
    
    the text direction of the legend.
  - register
```
public static void register(IsChart chart,
                            org.pepstock.charba.client.configuration.IsEventProvider provider)
```
    Adds the event provider implementation as handlers of chart.
    
    Parameters:
    
    chart - chart instance
    
    provider - event provider implmentation
  - setConfiguration
```
protected final void setConfiguration(T configuration)
```
    Parameters:
    
    configuration - the configuration to set
  - getConfiguration
```
protected final T getConfiguration()
```
    Returns the configuration element.
    
    Returns:
    
    the configuration element.
  - merge
```
public final void merge(NativeObjectContainer source,
                        String property)
```
    Merge a native object into this one with a specific property name.
    This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration into options of chart.
    
    Parameters:
    
    source - native object container to add
    
    property - property name
  - toJSON
```
public final String toJSON()
```
    Returns the JSON representation of the object.
    
    Returns:
    
    the JSON representation of the object.
  - getChart
```
public final IsChart getChart()
```
    Returns the chart instance
    
    Returns:
    
    the chart

Class Legend

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Legend

Method Detail

getLabels

onAdd

onRemove

hasClickHandlers

hasHoverHandlers

hasLeaveHandlers

setDisplay

isDisplay

setFullWidth

isFullWidth

setReverse

isReverse

setPosition

getPosition

setAlign

getAlign

setRtl

isRtl

setTextDirection

getTextDirection

register

setConfiguration

getConfiguration

merge

toJSON

getChart