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.LegendPosition

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) Constructor.
Legend(java.util.List<java.lang.Integer> colors, java.util.List<java.lang.String> labels) Constructor.

Method Summary

Modifier and Type	Method and Description
void	calculateDimensions(android.graphics.Paint labelpaint, ViewPortHandler viewPortHandler) Calculates the dimensions of the Legend.
java.lang.Boolean[]	getCalculatedLabelBreakPoints()
FSize[]	getCalculatedLabelSizes()
FSize[]	getCalculatedLineSizes()
int[]	getColors() returns all the colors the legend uses
Legend.LegendDirection	getDirection() returns the text direction of the legend
int[]	getExtraColors() colors that will be appended to the end of the colors array after calculating the legend.
java.lang.String[]	getExtraLabels() labels that will be appended to the end of the labels array after calculating the legend.
Legend.LegendForm	getForm() returns the current form/shape that is set for the legend
float	getFormSize() returns the size in dp of the legend forms
float	getFormToTextSpace() returns the space between the form and the actual label/text
float	getFullHeight(android.graphics.Paint labelpaint) Calculates the full height of the drawn legend.
float	getFullWidth(android.graphics.Paint labelpaint) calculates the full width the fully drawn legend will use in pixels
java.lang.String	getLabel(int index) Returns the legend-label at the given index.
java.lang.String[]	getLabels() returns all the labels the legend uses
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.LegendPosition	getPosition() returns the position of the legend relative to the chart
float	getStackSpace() returns the space that is left out between stacked forms (with no label)
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	isLegendCustom()
boolean	isWordWrapEnabled() If this is set, then word wrapping the legend is enabled.
void	resetCustom() Calling this will disable the custom legend labels (set by setCustom(...)).
void	setComputedColors(java.util.List<java.lang.Integer> colors) This method sets the automatically computed colors for the legend.
void	setComputedLabels(java.util.List<java.lang.String> labels) This method sets the automatically computed labels for the legend.
void	setCustom(int[] colors, java.lang.String[] labels) Sets a custom legend's labels and colors arrays.
void	setCustom(java.util.List<java.lang.Integer> colors, java.util.List<java.lang.String> labels) Sets a custom legend's labels and colors arrays.
void	setDirection(Legend.LegendDirection pos) sets the text direction of the legend
void	setExtra(int[] colors, java.lang.String[] labels) Colors and labels that will be appended to the end of the auto calculated colors and labels arrays after calculating the legend.
void	setExtra(java.util.List<java.lang.Integer> colors, java.util.List<java.lang.String> labels) Colors and labels that will be appended to the end of the auto calculated colors and labels arrays after calculating the legend.
void	setForm(Legend.LegendForm shape) sets the form/shape of the legend forms
void	setFormSize(float size) sets the size in pixels of the legend forms, this is internally converted in dp, default 8f
void	setFormToTextSpace(float space) sets the space between the form and the actual label/text, converts to dp internally
void	setMaxSizePercent(float maxSize) The maximum relative size out of the whole chart view.
void	setPosition(Legend.LegendPosition pos) sets the position of the legend relative to the whole chart
void	setStackSpace(float space) sets the space that is left out between stacked forms (with no label)
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(int[] colors,
              java.lang.String[] labels)

Constructor. Provide colors and labels for the legend.

Parameters:

colors -

labels -

Legend

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

Constructor. Provide colors and labels for the legend.

Parameters:

colors -

labels -

Method Detail

setComputedColors

public void setComputedColors(java.util.List<java.lang.Integer> colors)

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

Parameters:

colors -

setComputedLabels

public void setComputedLabels(java.util.List<java.lang.String> labels)

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

Parameters:

labels -

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

public int[] getColors()

returns all the colors the legend uses

Returns:

getLabels

public java.lang.String[] getLabels()

returns all the labels the legend uses

Returns:

getLabel

public java.lang.String getLabel(int index)

Returns the legend-label at the given index.

Parameters:

index -

Returns:

getExtraColors

public int[] getExtraColors()

colors that will be appended to the end of the colors array after calculating the legend.

getExtraLabels

public java.lang.String[] getExtraLabels()

labels that will be appended to the end of the labels array after calculating the legend. a null label will start a group.

setExtra

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

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

setExtra

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

Colors and labels that will be appended to the end of the auto calculated colors and labels arrays 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(int[] colors,
                      java.lang.String[] labels)

Sets a custom legend's labels and colors arrays. The colors count should match the labels count. * Each color is for the form drawn at the same index. * A null label will start a group. * A ColorTemplate.COLOR_SKIP color will avoid drawing a form This will disable the feature that automatically calculates the legend labels and colors 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<java.lang.Integer> colors,
                      java.util.List<java.lang.String> labels)

Sets a custom legend's labels and colors arrays. The colors count should match the labels count. * Each color is for the form drawn at the same index. * A null label will start a group. * A ColorTemplate.COLOR_SKIP color will avoid drawing a form This will disable the feature that automatically calculates the legend labels and colors 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 labels (set by setCustom(...)). Instead, the labels will again be calculated automatically (after notifyDataSetChanged() is called).

isLegendCustom

public boolean isLegendCustom()

Returns:

true if a custom legend labels and colors has been set default false (automatic legend)

getPosition

public Legend.LegendPosition getPosition()

returns the position of the legend relative to the chart

Returns:

setPosition

public void setPosition(Legend.LegendPosition pos)

sets the position of the legend relative to the whole chart

Parameters:

pos -

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 pixels of the legend forms, this is internally converted in dp, default 8f

Parameters:

size -

getFormSize

public float getFormSize()

returns the size in dp of the legend forms

Returns:

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:

mFormToTextSpace -

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 -

getFullWidth

public float getFullWidth(android.graphics.Paint labelpaint)

calculates the full width the fully drawn legend will use in pixels

Returns:

getFullHeight

public float getFullHeight(android.graphics.Paint labelpaint)

Calculates the full height of the drawn legend.

Parameters:

mLegendLabelPaint -

Returns:

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. / 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%)

Parameters:

maxSize -

getCalculatedLabelSizes

public FSize[] getCalculatedLabelSizes()

getCalculatedLabelBreakPoints

public java.lang.Boolean[] getCalculatedLabelBreakPoints()

getCalculatedLineSizes

public 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 -