Legend (Sencha GXT 3.1.4)

java.lang.Object
- com.sencha.gxt.chart.client.chart.Legend<M>

Type Parameters:
M - the data type of the legend

All Implemented Interfaces:

LegendHandler.HasLegendHandlers, LegendItemOutEvent.HasLegendItemOutHandlers, LegendItemOverEvent.HasLegendItemOverHandlers, LegendItemUpEvent.HasLegendItemUpHandlers, LegendSelectionEvent.HasLegendSelectionHandlers
```
public class Legend<M>
extends Object
implements LegendHandler.HasLegendHandlers, LegendSelectionEvent.HasLegendSelectionHandlers, LegendItemOutEvent.HasLegendItemOutHandlers, LegendItemOverEvent.HasLegendItemOverHandlers, LegendItemUpEvent.HasLegendItemUpHandlers
```
Defines a legend for a chart's series. The legend class displays a list of legend items each of them related with a series being rendered.

Constructor Summary

Constructors
Constructor and Description

Legend()

Constructors
Constructor and Description
`Legend()`

Method Summary

Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addLegendHandler(LegendHandler handler)` Adds a `LegendHandler` handler for `LegendSelectionEvent`, `LegendItemOutEvent`, `LegendItemOverEvent` and `LegendItemUpEvent` events.
`HandlerRegistration`	`addLegendItemOutHandler(LegendItemOutEvent.LegendItemOutHandler handler)` Adds a `LegendItemOutEvent.LegendItemOutHandler` handler for `LegendItemOutEvent` events.
`HandlerRegistration`	`addLegendItemOverHandler(LegendItemOverEvent.LegendItemOverHandler handler)` Adds a `LegendItemOverEvent.LegendItemOverHandler` handler for `LegendItemOverEvent` events.
`HandlerRegistration`	`addLegendItemUpHandler(LegendItemUpEvent.LegendItemUpHandler handler)` Adds a `LegendItemUpEvent.LegendItemUpHandler` handler for `LegendItemUpEvent` events.
`HandlerRegistration`	`addLegendSelectionHandler(LegendSelectionEvent.LegendSelectionHandler handler)` Adds a `LegendSelectionEvent.LegendSelectionHandler` handler for `LegendSelectionEvent` events.
`void`	`clear()` Removes all the sprites of the legend from the surface.
`void`	`create()` Create all the sprites for the legend.
`PreciseRectangle`	`getBBox()` Calculates and returns the bounding box of the legend.
`RectangleSprite`	`getBorderConfig()` Returns the border configuration.
`Chart<M>`	`getChart()` Returns the chart that the legend is attached.
`List<String>`	`getCurrentLegendTitles()` Returns the current list of titles used in the legend.
`int`	`getItemFromPoint(PrecisePoint point)` Returns the `LegendItem` at the given point.
`List<LegendItem<M>>`	`getItems()`
`SeriesRenderer<M>`	`getLabelRenderer()` Returns the series renderer for label sprites on the legend.
`int`	`getLegendInset()` Returns the inset margin used by the legend.
`SeriesRenderer<M>`	`getLineRenderer()` Returns the series renderer for line sprites on the legend.
`SeriesRenderer<M>`	`getMarkerRenderer()` Returns the series renderer for marker sprites on the legend.
`double`	`getPadding()` Returns the padding between legend items.
`Chart.Position`	`getPosition()` Returns the position of the legend.
`ToolTip`	`getToolTip()` Returns the currently generated tooltip for legend.
`LegendToolTipConfig<M>`	`getToolTipConfig()` Returns the tool tip configuration of the legend.
`boolean`	`isItemHiding()` Returns true if legend item hiding is enabled.
`boolean`	`isItemHighlighting()` Returns true if legend item highlighting is enabled.
`void`	`removeToolTip()` Removes the components tooltip (if one exists).
`void`	`setBorderConfig(RectangleSprite borderConfig)` Sets the border configuration.
`void`	`setChart(Chart<M> chart)` Sets the chart that the legend is attached.
`void`	`setItemHiding(boolean itemHiding)` Sets whether or not the legend uses item highlighting.
`void`	`setItemHighlighting(boolean itemHighlighting)` Sets whether or not the legend uses item highlighting.
`void`	`setLabelRenderer(SeriesRenderer<M> labelRenderer)` Sets the series renderer for label sprites on the legend.
`void`	`setLegendInset(int legendInset)` Sets the inset margin used by the legend.
`void`	`setLineRenderer(SeriesRenderer<M> lineRenderer)` Sets the series renderer for line sprites on the legend.
`void`	`setMarkerRenderer(SeriesRenderer<M> markerRenderer)` Sets the series renderer for marker sprites on the legend.
`void`	`setPadding(double padding)` Sets the padding between legend items.
`void`	`setPosition(Chart.Position position)` Sets the position of the legend.
`void`	`setToolTipConfig(LegendToolTipConfig<M> config)` Sets the tooltip configuration.
`void`	`updatePosition()` Adjusts the position of the legend to fit in its chart.

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

- Constructor Detail
  - Legend
```
public Legend()
```
- Method Detail
  - addLegendHandler
```
public HandlerRegistration addLegendHandler(LegendHandler handler)
```
    Description copied from interface: LegendHandler.HasLegendHandlers
    
    Adds a LegendHandler handler for LegendSelectionEvent, LegendItemOutEvent, LegendItemOverEvent and LegendItemUpEvent events.
    
    Specified by:
    
    addLegendHandler in interface LegendHandler.HasLegendHandlers
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - addLegendItemOutHandler
```
public HandlerRegistration addLegendItemOutHandler(LegendItemOutEvent.LegendItemOutHandler handler)
```
    Description copied from interface: LegendItemOutEvent.HasLegendItemOutHandlers
    
    Adds a LegendItemOutEvent.LegendItemOutHandler handler for LegendItemOutEvent events.
    
    Specified by:
    
    addLegendItemOutHandler in interface LegendItemOutEvent.HasLegendItemOutHandlers
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - addLegendItemOverHandler
```
public HandlerRegistration addLegendItemOverHandler(LegendItemOverEvent.LegendItemOverHandler handler)
```
    Description copied from interface: LegendItemOverEvent.HasLegendItemOverHandlers
    
    Adds a LegendItemOverEvent.LegendItemOverHandler handler for LegendItemOverEvent events.
    
    Specified by:
    
    addLegendItemOverHandler in interface LegendItemOverEvent.HasLegendItemOverHandlers
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - addLegendItemUpHandler
```
public HandlerRegistration addLegendItemUpHandler(LegendItemUpEvent.LegendItemUpHandler handler)
```
    Description copied from interface: LegendItemUpEvent.HasLegendItemUpHandlers
    
    Adds a LegendItemUpEvent.LegendItemUpHandler handler for LegendItemUpEvent events.
    
    Specified by:
    
    addLegendItemUpHandler in interface LegendItemUpEvent.HasLegendItemUpHandlers
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - addLegendSelectionHandler
```
public HandlerRegistration addLegendSelectionHandler(LegendSelectionEvent.LegendSelectionHandler handler)
```
    Description copied from interface: LegendSelectionEvent.HasLegendSelectionHandlers
    
    Adds a LegendSelectionEvent.LegendSelectionHandler handler for LegendSelectionEvent events.
    
    Specified by:
    
    addLegendSelectionHandler in interface LegendSelectionEvent.HasLegendSelectionHandlers
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - clear
```
public void clear()
```
    Removes all the sprites of the legend from the surface.
  - create
```
public void create()
```
    Create all the sprites for the legend.
  - getBBox
```
public PreciseRectangle getBBox()
```
    Calculates and returns the bounding box of the legend.
    
    Returns:
    the bounding box of the legend.
  - getBorderConfig
```
public RectangleSprite getBorderConfig()
```
    Returns the border configuration.
    
    Returns:
    the border configuration
  - getChart
```
public Chart<M> getChart()
```
    Returns the chart that the legend is attached.
    
    Returns:
    the chart that the legend is attached
  - getCurrentLegendTitles
```
public List<String> getCurrentLegendTitles()
```
    Returns the current list of titles used in the legend.
    
    Returns:
    the current list of titles used in the legend
  - getItemFromPoint
```
public int getItemFromPoint(PrecisePoint point)
```
    Returns the LegendItem at the given point. Returns null if no item at that point.
    
    Parameters:
    point - the point of the item
    
    Returns:
    the legend item
  - getItems
```
public List<LegendItem<M>> getItems()
```
  - getLabelRenderer
```
public SeriesRenderer<M> getLabelRenderer()
```
    Returns the series renderer for label sprites on the legend.
    
    Returns:
    the series renderer for label sprites on the legend
  - getLegendInset
```
public int getLegendInset()
```
    Returns the inset margin used by the legend.
    
    Returns:
    the inset margin used by the legend
  - getLineRenderer
```
public SeriesRenderer<M> getLineRenderer()
```
    Returns the series renderer for line sprites on the legend.
    
    Returns:
    the series renderer for line sprites on the legend
  - getMarkerRenderer
```
public SeriesRenderer<M> getMarkerRenderer()
```
    Returns the series renderer for marker sprites on the legend.
    
    Returns:
    the series renderer for marker sprites on the legend
  - getPadding
```
public double getPadding()
```
    Returns the padding between legend items.
    
    Returns:
    the padding between legend items
  - getPosition
```
public Chart.Position getPosition()
```
    Returns the position of the legend.
    
    Returns:
    the position of the legend
  - getToolTip
```
public ToolTip getToolTip()
```
    Returns the currently generated tooltip for legend.
    
    Returns:
    the currently generated tooltip for legend
  - getToolTipConfig
```
public LegendToolTipConfig<M> getToolTipConfig()
```
    Returns the tool tip configuration of the legend.
    
    Returns:
    the tool tip configuration of the legend
  - isItemHiding
```
public boolean isItemHiding()
```
    Returns true if legend item hiding is enabled.
    
    Returns:
    true if legend item hiding is enabled
  - isItemHighlighting
```
public boolean isItemHighlighting()
```
    Returns true if legend item highlighting is enabled.
    
    Returns:
    true if legend item highlighting is enabled
  - removeToolTip
```
public void removeToolTip()
```
    Removes the components tooltip (if one exists).
  - setBorderConfig
```
public void setBorderConfig(RectangleSprite borderConfig)
```
    Sets the border configuration.
    
    Parameters:
    borderConfig - the border configuration
  - setChart
```
public void setChart(Chart<M> chart)
```
    Sets the chart that the legend is attached.
    
    Parameters:
    chart - the chart that the legend is attached
  - setItemHiding
```
public void setItemHiding(boolean itemHiding)
```
    Sets whether or not the legend uses item highlighting.
    
    Parameters:
    itemHiding - true if the legend uses item highlighting
  - setItemHighlighting
```
public void setItemHighlighting(boolean itemHighlighting)
```
    Sets whether or not the legend uses item highlighting.
    
    Parameters:
    itemHighlighting - ture if the legend uses item highlighting
  - setLabelRenderer
```
public void setLabelRenderer(SeriesRenderer<M> labelRenderer)
```
    Sets the series renderer for label sprites on the legend.
    
    Parameters:
    labelRenderer - the series renderer for label sprites on the legend
  - setLegendInset
```
public void setLegendInset(int legendInset)
```
    Sets the inset margin used by the legend.
    
    Parameters:
    legendInset - the inset margin used by the legend
  - setLineRenderer
```
public void setLineRenderer(SeriesRenderer<M> lineRenderer)
```
    Sets the series renderer for line sprites on the legend.
    
    Parameters:
    lineRenderer - the series renderer for line sprites on the legend
  - setMarkerRenderer
```
public void setMarkerRenderer(SeriesRenderer<M> markerRenderer)
```
    Sets the series renderer for marker sprites on the legend.
    
    Parameters:
    markerRenderer - the series renderer for marker sprites on the legend
  - setPadding
```
public void setPadding(double padding)
```
    Sets the padding between legend items.
    
    Parameters:
    padding - the padding between legend items
  - setPosition
```
public void setPosition(Chart.Position position)
```
    Sets the position of the legend.
    
    Parameters:
    position - the position of the legend
  - setToolTipConfig
```
public void setToolTipConfig(LegendToolTipConfig<M> config)
```
    Sets the tooltip configuration.
    
    Parameters:
    config - the tooltip configuration
  - updatePosition
```
public void updatePosition()
```
    Adjusts the position of the legend to fit in its chart.

Class Legend<M>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Legend

Method Detail

addLegendHandler

addLegendItemOutHandler

addLegendItemOverHandler

addLegendItemUpHandler

addLegendSelectionHandler

clear

create

getBBox

getBorderConfig

getChart

getCurrentLegendTitles

getItemFromPoint

getItems

getLabelRenderer

getLegendInset

getLineRenderer

getMarkerRenderer

getPadding

getPosition

getToolTip

getToolTipConfig

isItemHiding

isItemHighlighting

removeToolTip

setBorderConfig

setChart

setItemHiding

setItemHighlighting

setLabelRenderer

setLegendInset

setLineRenderer

setMarkerRenderer

setPadding

setPosition

setToolTipConfig

updatePosition