com.github.mikephil.charting.data

Class BaseDataSet<T extends Entry>

java.lang.Object

com.github.mikephil.charting.data.BaseDataSet<T>

All Implemented Interfaces:

IDataSet<T>

Direct Known Subclasses:

DataSet, RealmBaseDataSet

public abstract class BaseDataSet<T extends Entry>
extends java.lang.Object
implements IDataSet<T>

Created by Philipp Jahoda on 21/10/15. This is the base dataset of all DataSets. It's purpose is to implement critical methods provided by the IDataSet interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected YAxis.AxisDependency	mAxisDependency this specifies which axis this DataSet should be plotted against
protected java.util.List<java.lang.Integer>	mColors List representing all colors that are used for this DataSet
protected boolean	mDrawValues if true, y-values are drawn on the chart
protected boolean	mHighlightEnabled if true, value highlightning is enabled
protected java.util.List<java.lang.Integer>	mValueColors List representing all colors that are used for drawing the actual values for this DataSet
protected ValueFormatter	mValueFormatter custom formatter that is used instead of the auto-formatter if set
protected float	mValueTextSize the size of the value-text labels
protected android.graphics.Typeface	mValueTypeface the typeface used for the value text
protected boolean	mVisible flag that indicates if the DataSet is visible or not

Constructor Summary

Constructors

Constructor and Description
BaseDataSet() Default constructor.
BaseDataSet(java.lang.String label) Constructor with label.

Method Summary

Methods

Modifier and Type	Method and Description
void	addColor(int color) Adds a new color to the colors array of the DataSet.
boolean	contains(T e) Checks if this DataSet contains the specified Entry.
YAxis.AxisDependency	getAxisDependency() Returns the axis this DataSet should be plotted against.
int	getColor() Returns the first color (index 0) of the colors-array this DataSet contains.
int	getColor(int index) Returns the color at the given index of the DataSet's color array.
java.util.List<java.lang.Integer>	getColors() ###### ###### COLOR GETTING RELATED METHODS ##### ######
int	getIndexInEntries(int xIndex) ###### ###### DATA RELATED METHODS ###### ######
java.lang.String	getLabel() Returns the label string that describes the DataSet.
java.util.List<java.lang.Integer>	getValueColors()
ValueFormatter	getValueFormatter() Returns the formatter used for drawing the values inside the chart.
int	getValueTextColor() Returns only the first color of all colors that are set to be used for the values.
int	getValueTextColor(int index) Returns the color at the specified index that is used for drawing the values inside the chart.
float	getValueTextSize() Returns the text size that is used for drawing the values inside the chart
android.graphics.Typeface	getValueTypeface() Returns the typeface that is used for drawing the values inside the chart
boolean	isDrawValuesEnabled() Returns true if y-value drawing is enabled, false if not
boolean	isHighlightEnabled() returns true if highlighting of values is enabled, false if not
boolean	isVisible() Returns true if this DataSet is visible inside the chart, or false if it is currently hidden.
void	notifyDataSetChanged() Use this method to tell the data set that the underlying data has changed.
boolean	removeEntry(int xIndex) Removes the Entry object that has the given xIndex from the DataSet.
boolean	removeFirst() Removes the first Entry (at index 0) of this DataSet from the entries array.
boolean	removeLast() Removes the last Entry (at index size-1) of this DataSet from the entries array.
void	resetColors() Resets all colors of this DataSet and recreates the colors array.
void	setAxisDependency(YAxis.AxisDependency dependency) Set the y-axis this DataSet should be plotted against (either LEFT or RIGHT).
void	setColor(int color) Sets the one and ONLY color that should be used for this DataSet.
void	setColor(int color, int alpha) Sets a color with a specific alpha value.
void	setColors(int[] colors) Sets the colors that should be used fore this DataSet.
void	setColors(int[] colors, android.content.Context c) Sets the colors that should be used fore this DataSet.
void	setColors(int[] colors, int alpha) Sets colors with a specific alpha value.
void	setColors(java.util.List<java.lang.Integer> colors) Sets the colors that should be used fore this DataSet.
void	setDrawValues(boolean enabled) set this to true to draw y-values on the chart NOTE (for bar and linechart): if "maxvisiblecount" is reached, no values will be drawn even if this is enabled
void	setHighlightEnabled(boolean enabled) If set to true, value highlighting is enabled which means that values can be highlighted programmatically or by touch gesture.
void	setLabel(java.lang.String label) ###### ###### OTHER STYLING RELATED METHODS ##### ######
void	setValueFormatter(ValueFormatter f) Sets the formatter to be used for drawing the values inside the chart.
void	setValueTextColor(int color) Sets the color the value-labels of this DataSet should have.
void	setValueTextColors(java.util.List<java.lang.Integer> colors) Sets a list of colors to be used as the colors for the drawn values.
void	setValueTextSize(float size) Sets the text-size of the value-labels of this DataSet in dp.
void	setValueTypeface(android.graphics.Typeface tf) Sets a Typeface for the value-labels of this DataSet.
void	setVisible(boolean visible) Set the visibility of this DataSet.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.mikephil.charting.interfaces.datasets.IDataSet

addEntry, addEntryOrdered, calcMinMax, clear, getEntryCount, getEntryForIndex, getEntryForXIndex, getEntryForXIndex, getEntryIndex, getEntryIndex, getYMax, getYMin, getYValForXIndex, removeEntry

Field Detail

mColors

protected java.util.List<java.lang.Integer> mColors

List representing all colors that are used for this DataSet

mValueColors

protected java.util.List<java.lang.Integer> mValueColors

List representing all colors that are used for drawing the actual values for this DataSet

mAxisDependency

protected YAxis.AxisDependency mAxisDependency

this specifies which axis this DataSet should be plotted against

mHighlightEnabled

protected boolean mHighlightEnabled

if true, value highlightning is enabled

mValueFormatter

protected transient ValueFormatter mValueFormatter

custom formatter that is used instead of the auto-formatter if set

mValueTypeface

protected android.graphics.Typeface mValueTypeface

the typeface used for the value text

mDrawValues

protected boolean mDrawValues

if true, y-values are drawn on the chart

mValueTextSize

protected float mValueTextSize

the size of the value-text labels

mVisible

protected boolean mVisible

flag that indicates if the DataSet is visible or not

Constructor Detail

BaseDataSet

public BaseDataSet()

Default constructor.

BaseDataSet

public BaseDataSet(java.lang.String label)

Constructor with label.

Parameters:

label -

Method Detail

notifyDataSetChanged

public void notifyDataSetChanged()

Use this method to tell the data set that the underlying data has changed.

getColors

public java.util.List<java.lang.Integer> getColors()

###### ###### COLOR GETTING RELATED METHODS ##### ######

Specified by:

getColors in interface IDataSet<T extends Entry>

Returns:

getValueColors

public java.util.List<java.lang.Integer> getValueColors()

getColor

public int getColor()

Description copied from interface: IDataSet

Returns the first color (index 0) of the colors-array this DataSet contains. This is only used for performance reasons when only one color is in the colors array (size == 1)

Specified by:

getColor in interface IDataSet<T extends Entry>

Returns:

getColor

public int getColor(int index)

Description copied from interface: IDataSet

Returns the color at the given index of the DataSet's color array. Performs a IndexOutOfBounds check by modulus.

Specified by:

getColor in interface IDataSet<T extends Entry>

Returns:

setColors

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

Sets the colors that should be used fore this DataSet. Colors are reused as soon as the number of Entries the DataSet represents is higher than the size of the colors array. If you are using colors from the resources, make sure that the colors are already prepared (by calling getResources().getColor(...)) before adding them to the DataSet.

Parameters:

colors -

setColors

public void setColors(int[] colors)

Sets the colors that should be used fore this DataSet. Colors are reused as soon as the number of Entries the DataSet represents is higher than the size of the colors array. If you are using colors from the resources, make sure that the colors are already prepared (by calling getResources().getColor(...)) before adding them to the DataSet.

Parameters:

colors -

setColors

public void setColors(int[] colors,
             android.content.Context c)

Sets the colors that should be used fore this DataSet. Colors are reused as soon as the number of Entries the DataSet represents is higher than the size of the colors array. You can use "new int[] { R.color.red, R.color.green, ... }" to provide colors for this method. Internally, the colors are resolved using getResources().getColor(...)

Parameters:

colors -

addColor

public void addColor(int color)

Adds a new color to the colors array of the DataSet.

Parameters:

color -

setColor

public void setColor(int color)

Sets the one and ONLY color that should be used for this DataSet. Internally, this recreates the colors array and adds the specified color.

Parameters:

color -

setColor

public void setColor(int color,
            int alpha)

Sets a color with a specific alpha value.

Parameters:

color -

alpha - from 0-255

setColors

public void setColors(int[] colors,
             int alpha)

Sets colors with a specific alpha value.

Parameters:

colors -

alpha -

resetColors

public void resetColors()

Resets all colors of this DataSet and recreates the colors array.

setLabel

public void setLabel(java.lang.String label)

###### ###### OTHER STYLING RELATED METHODS ##### ######

Specified by:

setLabel in interface IDataSet<T extends Entry>

getLabel

public java.lang.String getLabel()

Description copied from interface: IDataSet

Returns the label string that describes the DataSet.

Specified by:

getLabel in interface IDataSet<T extends Entry>

Returns:

setHighlightEnabled

public void setHighlightEnabled(boolean enabled)

Description copied from interface: IDataSet

If set to true, value highlighting is enabled which means that values can be highlighted programmatically or by touch gesture.

Specified by:

setHighlightEnabled in interface IDataSet<T extends Entry>

isHighlightEnabled

public boolean isHighlightEnabled()

Description copied from interface: IDataSet

returns true if highlighting of values is enabled, false if not

Specified by:

isHighlightEnabled in interface IDataSet<T extends Entry>

Returns:

setValueFormatter

public void setValueFormatter(ValueFormatter f)

Description copied from interface: IDataSet

Sets the formatter to be used for drawing the values inside the chart. If no formatter is set, the chart will automatically determine a reasonable formatting (concerning decimals) for all the values that are drawn inside the chart. Use chart.getDefaultValueFormatter() to use the formatter calculated by the chart.

Specified by:

setValueFormatter in interface IDataSet<T extends Entry>

getValueFormatter

public ValueFormatter getValueFormatter()

Description copied from interface: IDataSet

Returns the formatter used for drawing the values inside the chart.

Specified by:

getValueFormatter in interface IDataSet<T extends Entry>

Returns:

setValueTextColor

public void setValueTextColor(int color)

Description copied from interface: IDataSet

Sets the color the value-labels of this DataSet should have.

Specified by:

setValueTextColor in interface IDataSet<T extends Entry>

setValueTextColors

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

Description copied from interface: IDataSet

Sets a list of colors to be used as the colors for the drawn values.

Specified by:

setValueTextColors in interface IDataSet<T extends Entry>

setValueTypeface

public void setValueTypeface(android.graphics.Typeface tf)

Description copied from interface: IDataSet

Sets a Typeface for the value-labels of this DataSet.

Specified by:

setValueTypeface in interface IDataSet<T extends Entry>

setValueTextSize

public void setValueTextSize(float size)

Description copied from interface: IDataSet

Sets the text-size of the value-labels of this DataSet in dp.

Specified by:

setValueTextSize in interface IDataSet<T extends Entry>

getValueTextColor

public int getValueTextColor()

Description copied from interface: IDataSet

Returns only the first color of all colors that are set to be used for the values.

Specified by:

getValueTextColor in interface IDataSet<T extends Entry>

Returns:

getValueTextColor

public int getValueTextColor(int index)

Description copied from interface: IDataSet

Returns the color at the specified index that is used for drawing the values inside the chart. Uses modulus internally.

Specified by:

getValueTextColor in interface IDataSet<T extends Entry>

Returns:

getValueTypeface

public android.graphics.Typeface getValueTypeface()

Description copied from interface: IDataSet

Returns the typeface that is used for drawing the values inside the chart

Specified by:

getValueTypeface in interface IDataSet<T extends Entry>

Returns:

getValueTextSize

public float getValueTextSize()

Description copied from interface: IDataSet

Returns the text size that is used for drawing the values inside the chart

Specified by:

getValueTextSize in interface IDataSet<T extends Entry>

Returns:

setDrawValues

public void setDrawValues(boolean enabled)

Description copied from interface: IDataSet

set this to true to draw y-values on the chart NOTE (for bar and linechart): if "maxvisiblecount" is reached, no values will be drawn even if this is enabled

Specified by:

setDrawValues in interface IDataSet<T extends Entry>

isDrawValuesEnabled

public boolean isDrawValuesEnabled()

Description copied from interface: IDataSet

Returns true if y-value drawing is enabled, false if not

Specified by:

isDrawValuesEnabled in interface IDataSet<T extends Entry>

Returns:

setVisible

public void setVisible(boolean visible)

Description copied from interface: IDataSet

Set the visibility of this DataSet. If not visible, the DataSet will not be drawn to the chart upon refreshing it.

Specified by:

setVisible in interface IDataSet<T extends Entry>

isVisible

public boolean isVisible()

Description copied from interface: IDataSet

Returns true if this DataSet is visible inside the chart, or false if it is currently hidden.

Specified by:

isVisible in interface IDataSet<T extends Entry>

Returns:

getAxisDependency

public YAxis.AxisDependency getAxisDependency()

Description copied from interface: IDataSet

Returns the axis this DataSet should be plotted against.

Specified by:

getAxisDependency in interface IDataSet<T extends Entry>

Returns:

setAxisDependency

public void setAxisDependency(YAxis.AxisDependency dependency)

Description copied from interface: IDataSet

Set the y-axis this DataSet should be plotted against (either LEFT or RIGHT). Default: LEFT

Specified by:

setAxisDependency in interface IDataSet<T extends Entry>

getIndexInEntries

public int getIndexInEntries(int xIndex)

###### ###### DATA RELATED METHODS ###### ######

Specified by:

getIndexInEntries in interface IDataSet<T extends Entry>

Returns:

removeFirst

public boolean removeFirst()

Description copied from interface: IDataSet

Removes the first Entry (at index 0) of this DataSet from the entries array. Returns true if successful, false if not.

Specified by:

removeFirst in interface IDataSet<T extends Entry>

Returns:

removeLast

public boolean removeLast()

Description copied from interface: IDataSet

Removes the last Entry (at index size-1) of this DataSet from the entries array. Returns true if successful, false if not.

Specified by:

removeLast in interface IDataSet<T extends Entry>

Returns:

removeEntry

public boolean removeEntry(int xIndex)

Description copied from interface: IDataSet

Removes the Entry object that has the given xIndex from the DataSet. Returns true if an Entry was removed, false if no Entry could be removed.

Specified by:

removeEntry in interface IDataSet<T extends Entry>

contains

public boolean contains(T e)

Description copied from interface: IDataSet

Checks if this DataSet contains the specified Entry. Returns true if so, false if not. NOTE: Performance is pretty bad on this one, do not over-use in performance critical situations.

Specified by:

contains in interface IDataSet<T extends Entry>

Returns: