com.github.mikephil.charting.components

Class Legend

java.lang.Object

com.github.mikephil.charting.components.ComponentBase

com.github.mikephil.charting.components.Legend

public class Legend
extends ComponentBase

Class representing the legend of the chart. The legend will contain one entry per color and DataSet. Multiple colors in one DataSet are grouped together. The legend object is NOT available before setting data to the chart.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Legend.LegendDirection
static class	Legend.LegendForm
static class	Legend.LegendHorizontalAlignment
static class	Legend.LegendOrientation
static class	Legend.LegendPosition Deprecated.
static class	Legend.LegendVerticalAlignment

Field Summary

Fields

Modifier and Type	Field and Description
float	mNeededHeight the total height of the legend (needed height space)
float	mNeededWidth the total width of the legend (needed width space)
float	mTextHeightMax
float	mTextWidthMax

Fields inherited from class com.github.mikephil.charting.components.ComponentBase

mEnabled, mTextColor, mTextSize, mTypeface, mXOffset, mYOffset

Constructor Summary

Constructors

Constructor and Description
Legend() default constructor
Legend(int[] colors, java.lang.String[] labels) Deprecated.
Legend(LegendEntry[] entries) Constructor.
Legend(java.util.List<java.lang.Integer> colors, java.util.List<java.lang.String> labels) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	calculateDimensions(android.graphics.Paint labelpaint, ViewPortHandler viewPortHandler) Calculates the dimensions of the Legend.
java.util.List<java.lang.Boolean>	getCalculatedLabelBreakPoints()
java.util.List<FSize>	getCalculatedLabelSizes()
java.util.List<FSize>	getCalculatedLineSizes()
int[]	getColors() Deprecated.
Legend.LegendDirection	getDirection() returns the text direction of the legend
LegendEntry[]	getEntries()
int[]	getExtraColors() Deprecated.
LegendEntry[]	getExtraEntries()
java.lang.String[]	getExtraLabels() Deprecated.
Legend.LegendForm	getForm() returns the current form/shape that is set for the legend
android.graphics.DashPathEffect	getFormLineDashEffect()
float	getFormLineWidth() returns the line width in dp for drawing forms that consist of lines
float	getFormSize() returns the size in dp of the legend forms
float	getFormToTextSpace() returns the space between the form and the actual label/text
Legend.LegendHorizontalAlignment	getHorizontalAlignment() returns the horizontal alignment of the legend
java.lang.String[]	getLabels() Deprecated.
float	getMaximumEntryHeight(android.graphics.Paint p) returns the maximum height in pixels across all legend labels
float	getMaximumEntryWidth(android.graphics.Paint p) returns the maximum length in pixels across all legend labels + formsize + formtotextspace
float	getMaxSizePercent() The maximum relative size out of the whole chart view.
Legend.LegendOrientation	getOrientation() returns the orientation of the legend
Legend.LegendPosition	getPosition() Deprecated.
float	getStackSpace() returns the space that is left out between stacked forms (with no label)
Legend.LegendVerticalAlignment	getVerticalAlignment() returns the vertical alignment of the legend
float	getXEntrySpace() returns the space between the legend entries on a horizontal axis in pixels
float	getYEntrySpace() returns the space between the legend entries on a vertical axis in pixels
boolean	isDrawInsideEnabled() returns whether the legend will draw inside the chart or outside
boolean	isLegendCustom()
boolean	isWordWrapEnabled() If this is set, then word wrapping the legend is enabled.
void	resetCustom() Calling this will disable the custom legend entries (set by setCustom(...)).
void	setCustom(LegendEntry[] entries) Sets a custom legend's entries array.
void	setCustom(java.util.List<LegendEntry> entries) Sets a custom legend's entries array.
void	setDirection(Legend.LegendDirection pos) sets the text direction of the legend
void	setDrawInside(boolean value) sets whether the legend will draw inside the chart or outside
void	setEntries(java.util.List<LegendEntry> entries) This method sets the automatically computed colors for the legend.
void	setExtra(int[] colors, java.lang.String[] labels) Entries that will be appended to the end of the auto calculated entries after calculating the legend.
void	setExtra(LegendEntry[] entries)
void	setExtra(java.util.List<java.lang.Integer> colors, java.util.List<java.lang.String> labels) Deprecated.
void	setExtra(java.util.List<LegendEntry> entries)
void	setForm(Legend.LegendForm shape) sets the form/shape of the legend forms
void	setFormLineDashEffect(android.graphics.DashPathEffect dashPathEffect) Sets the line dash path effect used for shapes that consist of lines.
void	setFormLineWidth(float size) sets the line width in dp for forms that consist of lines, default 3f
void	setFormSize(float size) sets the size in dp of the legend forms, default 8f
void	setFormToTextSpace(float space) sets the space between the form and the actual label/text, converts to dp internally
void	setHorizontalAlignment(Legend.LegendHorizontalAlignment value) sets the horizontal alignment of the legend
void	setMaxSizePercent(float maxSize) The maximum relative size out of the whole chart view.
void	setOrientation(Legend.LegendOrientation value) sets the orientation of the legend
void	setPosition(Legend.LegendPosition newValue) Deprecated.
void	setStackSpace(float space) sets the space that is left out between stacked forms (with no label)
void	setVerticalAlignment(Legend.LegendVerticalAlignment value) sets the vertical alignment of the legend
void	setWordWrapEnabled(boolean enabled) Should the legend word wrap? / this is currently supported only for: BelowChartLeft, BelowChartRight, BelowChartCenter.
void	setXEntrySpace(float space) sets the space between the legend entries on a horizontal axis in pixels, converts to dp internally
void	setYEntrySpace(float space) sets the space between the legend entries on a vertical axis in pixels, converts to dp internally

Methods inherited from class com.github.mikephil.charting.components.ComponentBase

getTextColor, getTextSize, getTypeface, getXOffset, getYOffset, isEnabled, setEnabled, setTextColor, setTextSize, setTypeface, setXOffset, setYOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mNeededWidth

public float mNeededWidth

the total width of the legend (needed width space)

mNeededHeight

public float mNeededHeight

the total height of the legend (needed height space)

mTextHeightMax

public float mTextHeightMax

mTextWidthMax

public float mTextWidthMax

Constructor Detail

Legend

public Legend()

default constructor

Legend

public Legend(LegendEntry[] entries)

Constructor. Provide entries for the legend.

Parameters:

entries -

Legend

@Deprecated
public Legend(int[] colors,
                          java.lang.String[] labels)

Deprecated.

Legend

@Deprecated
public Legend(java.util.List<java.lang.Integer> colors,
                          java.util.List<java.lang.String> labels)

Deprecated.

Method Detail

setEntries

public void setEntries(java.util.List<LegendEntry> entries)

This method sets the automatically computed colors for the legend. Use setCustom(...) to set custom colors.

Parameters:

entries -

getEntries

public LegendEntry[] getEntries()

getMaximumEntryWidth

public float getMaximumEntryWidth(android.graphics.Paint p)

returns the maximum length in pixels across all legend labels + formsize + formtotextspace

Parameters:

p - the paint object used for rendering the text

Returns:

getMaximumEntryHeight

public float getMaximumEntryHeight(android.graphics.Paint p)

returns the maximum height in pixels across all legend labels

Parameters:

p - the paint object used for rendering the text

Returns:

getColors

@Deprecated
public int[] getColors()

Deprecated.

getLabels

@Deprecated
public java.lang.String[] getLabels()

Deprecated.

getExtraColors

@Deprecated
public int[] getExtraColors()

Deprecated.

getExtraLabels

@Deprecated
public java.lang.String[] getExtraLabels()

Deprecated.

getExtraEntries

public LegendEntry[] getExtraEntries()

setExtra

public void setExtra(java.util.List<LegendEntry> entries)

setExtra

public void setExtra(LegendEntry[] entries)

setExtra

@Deprecated
public void setExtra(java.util.List<java.lang.Integer> colors,
                                 java.util.List<java.lang.String> labels)

Deprecated.

setExtra

public void setExtra(int[] colors,
                     java.lang.String[] labels)

Entries that will be appended to the end of the auto calculated entries after calculating the legend. (if the legend has already been calculated, you will need to call notifyDataSetChanged() to let the changes take effect)

setCustom

public void setCustom(LegendEntry[] entries)

Sets a custom legend's entries array. * A null label will start a group. This will disable the feature that automatically calculates the legend entries from the datasets. Call resetCustom() to re-enable automatic calculation (and then notifyDataSetChanged() is needed to auto-calculate the legend again)

setCustom

public void setCustom(java.util.List<LegendEntry> entries)

Sets a custom legend's entries array. * A null label will start a group. This will disable the feature that automatically calculates the legend entries from the datasets. Call resetCustom() to re-enable automatic calculation (and then notifyDataSetChanged() is needed to auto-calculate the legend again)

resetCustom

public void resetCustom()

Calling this will disable the custom legend entries (set by setCustom(...)). Instead, the entries will again be calculated automatically (after notifyDataSetChanged() is called).

isLegendCustom

public boolean isLegendCustom()

Returns:

true if a custom legend entries has been set default false (automatic legend)

getPosition

@Deprecated
public Legend.LegendPosition getPosition()

Deprecated.

This property is deprecated - Use `horizontalAlignment`, `verticalAlignment`, `orientation`, `drawInside`, `direction`.

setPosition

@Deprecated
public void setPosition(Legend.LegendPosition newValue)

Deprecated.

This property is deprecated - Use `horizontalAlignment`, `verticalAlignment`, `orientation`, `drawInside`, `direction`.

getHorizontalAlignment

public Legend.LegendHorizontalAlignment getHorizontalAlignment()

returns the horizontal alignment of the legend

Returns:

setHorizontalAlignment

public void setHorizontalAlignment(Legend.LegendHorizontalAlignment value)

sets the horizontal alignment of the legend

Parameters:

value -

getVerticalAlignment

public Legend.LegendVerticalAlignment getVerticalAlignment()

returns the vertical alignment of the legend

Returns:

setVerticalAlignment

public void setVerticalAlignment(Legend.LegendVerticalAlignment value)

sets the vertical alignment of the legend

Parameters:

value -

getOrientation

public Legend.LegendOrientation getOrientation()

returns the orientation of the legend

Returns:

setOrientation

public void setOrientation(Legend.LegendOrientation value)

sets the orientation of the legend

Parameters:

value -

isDrawInsideEnabled

public boolean isDrawInsideEnabled()

returns whether the legend will draw inside the chart or outside

Returns:

setDrawInside

public void setDrawInside(boolean value)

sets whether the legend will draw inside the chart or outside

Parameters:

value -

getDirection

public Legend.LegendDirection getDirection()

returns the text direction of the legend

Returns:

setDirection

public void setDirection(Legend.LegendDirection pos)

sets the text direction of the legend

Parameters:

pos -

getForm

public Legend.LegendForm getForm()

returns the current form/shape that is set for the legend

Returns:

setForm

public void setForm(Legend.LegendForm shape)

sets the form/shape of the legend forms

Parameters:

shape -

setFormSize

public void setFormSize(float size)

sets the size in dp of the legend forms, default 8f

Parameters:

size -

getFormSize

public float getFormSize()

returns the size in dp of the legend forms

Returns:

setFormLineWidth

public void setFormLineWidth(float size)

sets the line width in dp for forms that consist of lines, default 3f

Parameters:

size -

getFormLineWidth

public float getFormLineWidth()

returns the line width in dp for drawing forms that consist of lines

Returns:

setFormLineDashEffect

public void setFormLineDashEffect(android.graphics.DashPathEffect dashPathEffect)

Sets the line dash path effect used for shapes that consist of lines.

Parameters:

dashPathEffect -

getFormLineDashEffect

public android.graphics.DashPathEffect getFormLineDashEffect()

Returns:

The line dash path effect used for shapes that consist of lines.

getXEntrySpace

public float getXEntrySpace()

returns the space between the legend entries on a horizontal axis in pixels

Returns:

setXEntrySpace

public void setXEntrySpace(float space)

sets the space between the legend entries on a horizontal axis in pixels, converts to dp internally

Parameters:

space -

getYEntrySpace

public float getYEntrySpace()

returns the space between the legend entries on a vertical axis in pixels

Returns:

setYEntrySpace

public void setYEntrySpace(float space)

sets the space between the legend entries on a vertical axis in pixels, converts to dp internally

Parameters:

space -

getFormToTextSpace

public float getFormToTextSpace()

returns the space between the form and the actual label/text

Returns:

setFormToTextSpace

public void setFormToTextSpace(float space)

sets the space between the form and the actual label/text, converts to dp internally

Parameters:

space -

getStackSpace

public float getStackSpace()

returns the space that is left out between stacked forms (with no label)

Returns:

setStackSpace

public void setStackSpace(float space)

sets the space that is left out between stacked forms (with no label)

Parameters:

space -

setWordWrapEnabled

public void setWordWrapEnabled(boolean enabled)

Should the legend word wrap? / this is currently supported only for: BelowChartLeft, BelowChartRight, BelowChartCenter. / note that word wrapping a legend takes a toll on performance. / you may want to set maxSizePercent when word wrapping, to set the point where the text wraps. / default: false

Parameters:

enabled -

isWordWrapEnabled

public boolean isWordWrapEnabled()

If this is set, then word wrapping the legend is enabled. This means the legend will not be cut off if too long.

Returns:

getMaxSizePercent

public float getMaxSizePercent()

The maximum relative size out of the whole chart view. / If the legend is to the right/left of the chart, then this affects the width of the legend. / If the legend is to the top/bottom of the chart, then this affects the height of the legend. / If the legend is the center of the piechart, then this defines the size of the rectangular bounds out of the size of the "hole". / default: 0.95f (95%)

Returns:

setMaxSizePercent

public void setMaxSizePercent(float maxSize)

The maximum relative size out of the whole chart view. / If the legend is to the right/left of the chart, then this affects the width of the legend. / If the legend is to the top/bottom of the chart, then this affects the height of the legend. / default: 0.95f (95%)

Parameters:

maxSize -

getCalculatedLabelSizes

public java.util.List<FSize> getCalculatedLabelSizes()

getCalculatedLabelBreakPoints

public java.util.List<java.lang.Boolean> getCalculatedLabelBreakPoints()

getCalculatedLineSizes

public java.util.List<FSize> getCalculatedLineSizes()

calculateDimensions

public void calculateDimensions(android.graphics.Paint labelpaint,
                                ViewPortHandler viewPortHandler)

Calculates the dimensions of the Legend. This includes the maximum width and height of a single entry, as well as the total width and height of the Legend.

Parameters:

labelpaint -