LegendRenderer

java.lang.Object
- com.jjoe64.graphview.LegendRenderer

Direct Known Subclasses:

UniqueLegendRenderer
```
public class LegendRenderer
extends java.lang.Object
```
The default renderer for the legend box

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LegendRenderer.LegendAlign
alignment of the legend

Nested Classes
Modifier and Type	Class and Description
`static class`	`LegendRenderer.LegendAlign` alignment of the legend

Constructor Summary

Constructors
Constructor and Description

LegendRenderer(GraphView graphView)
creates legend renderer

Constructors
Constructor and Description
`LegendRenderer(GraphView graphView)` creates legend renderer

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw(Canvas canvas)` draws the legend if it is visible
`LegendRenderer.LegendAlign`	`getAlign()`
`protected java.util.List<Series>`	`getAllSeries()`
`int`	`getBackgroundColor()`
`int`	`getMargin()`
`int`	`getPadding()` padding is the space between the edge of the box and the beginning of the text
`int`	`getSpacing()`
`int`	`getTextColor()`
`float`	`getTextSize()`
`int`	`getWidth()` the width of the box exclusive padding
`boolean`	`isVisible()`
`void`	`resetStyles()` resets the styles to the defaults and clears the legend width cache
`void`	`setAlign(LegendRenderer.LegendAlign align)`
`void`	`setBackgroundColor(int backgroundColor)`
`void`	`setFixedPosition(int x, int y)` Use fixed coordinates to position the legend.
`void`	`setMargin(int margin)`
`void`	`setPadding(int padding)` padding is the space between the edge of the box and the beginning of the text
`void`	`setSpacing(int spacing)` set the spacing between the text lines
`void`	`setTextColor(int textColor)`
`void`	`setTextSize(float textSize)` sets the font size.
`void`	`setVisible(boolean mIsVisible)` set the flag whether the legend will be drawn
`void`	`setWidth(int width)` the width of the box exclusive padding

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

- Constructor Detail
  - LegendRenderer
```
public LegendRenderer(GraphView graphView)
```
    creates legend renderer
    
    Parameters:
    
    graphView - regarding graphview
- Method Detail
  - resetStyles
```
public void resetStyles()
```
    resets the styles to the defaults and clears the legend width cache
  - getAllSeries
```
protected java.util.List<Series> getAllSeries()
```
  - draw
```
public void draw(Canvas canvas)
```
    draws the legend if it is visible
    
    Parameters:
    
    canvas - canvas
    
    See Also:
    
    setVisible(boolean)
  - isVisible
```
public boolean isVisible()
```
    Returns:
    
    the flag whether the legend will be drawn
  - setVisible
```
public void setVisible(boolean mIsVisible)
```
    set the flag whether the legend will be drawn
    
    Parameters:
    
    mIsVisible - visible flag
  - getTextSize
```
public float getTextSize()
```
    Returns:
    
    font size
  - setTextSize
```
public void setTextSize(float textSize)
```
    sets the font size. this will clear the internal legend width cache
    
    Parameters:
    
    textSize - font size
  - getSpacing
```
public int getSpacing()
```
    Returns:
    
    the spacing between the text lines
  - setSpacing
```
public void setSpacing(int spacing)
```
    set the spacing between the text lines
    
    Parameters:
    
    spacing - the spacing between the text lines
  - getPadding
```
public int getPadding()
```
    padding is the space between the edge of the box and the beginning of the text
    
    Returns:
    
    padding from edge to text
  - setPadding
```
public void setPadding(int padding)
```
    padding is the space between the edge of the box and the beginning of the text
    
    Parameters:
    
    padding - padding from edge to text
  - getWidth
```
public int getWidth()
```
    the width of the box exclusive padding
    
    Returns:
    
    the width of the box 0 => auto
  - setWidth
```
public void setWidth(int width)
```
    the width of the box exclusive padding
    
    Parameters:
    
    width - the width of the box exclusive padding 0 => auto
  - getBackgroundColor
```
public int getBackgroundColor()
```
    Returns:
    
    background color of the box it is recommended to use semi-transparent color.
  - setBackgroundColor
```
public void setBackgroundColor(int backgroundColor)
```
    Parameters:
    
    backgroundColor - background color of the box it is recommended to use semi-transparent color.
  - getMargin
```
public int getMargin()
```
    Returns:
    
    margin from the edge of the box to the corner of the graphview
  - setMargin
```
public void setMargin(int margin)
```
    Parameters:
    
    margin - margin from the edge of the box to the corner of the graphview
  - getAlign
```
public LegendRenderer.LegendAlign getAlign()
```
    Returns:
    
    the vertical alignment of the box
  - setAlign
```
public void setAlign(LegendRenderer.LegendAlign align)
```
    Parameters:
    
    align - the vertical alignment of the box
  - getTextColor
```
public int getTextColor()
```
    Returns:
    
    font color
  - setTextColor
```
public void setTextColor(int textColor)
```
    Parameters:
    
    textColor - font color
  - setFixedPosition
```
public void setFixedPosition(int x,
                             int y)
```
    Use fixed coordinates to position the legend. This will override the align setting.
    
    Parameters:
    
    x - x coordinates in pixel
    
    y - y coordinates in pixel

Class LegendRenderer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LegendRenderer

Method Detail

resetStyles

getAllSeries

draw

isVisible

setVisible

getTextSize

setTextSize

getSpacing

setSpacing

getPadding

setPadding

getWidth

setWidth

getBackgroundColor

setBackgroundColor

getMargin

setMargin

getAlign

setAlign

getTextColor

setTextColor

setFixedPosition