com.github.mikephil.charting.data

Class ChartData<T extends IDataSet<? extends Entry>>

java.lang.Object

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

Direct Known Subclasses:

BarLineScatterCandleBubbleData, PieData, RadarData

public abstract class ChartData<T extends IDataSet<? extends Entry>>
extends java.lang.Object

Class that holds all relevant data that represents the chart. That involves at least one (or more) DataSets, and an array of x-values.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<T>	mDataSets array that holds all DataSets the ChartData object represents
protected float	mLeftAxisMax
protected float	mLeftAxisMin
protected float	mRightAxisMax
protected float	mRightAxisMin
protected java.util.List<java.lang.String>	mXVals holds all x-values the chart represents
protected float	mYMax maximum y-value in the y-value array across all axes
protected float	mYMin the minimum y-value in the y-value array across all axes

Constructor Summary

Constructors

Constructor and Description
ChartData()
ChartData(java.util.List<java.lang.String> xVals) Constructor for only x-values.
ChartData(java.util.List<java.lang.String> xVals, java.util.List<T> sets) constructor for chart data
ChartData(java.lang.String[] xVals) Constructor for only x-values.
ChartData(java.lang.String[] xVals, java.util.List<T> sets) constructor that takes string array instead of List string

Method Summary

Modifier and Type	Method and Description
void	addDataSet(T d) Adds a DataSet dynamically.
void	addEntry(Entry e, int dataSetIndex) Adds an Entry to the DataSet at the specified index.
void	addXValue(java.lang.String xVal) Adds a new x-value to the chart data.
void	calcMinMax(int start, int end) calc minimum and maximum y value over all datasets
protected void	calcYValueCount() Calculates the total number of y-values across all DataSets the ChartData represents.
void	clearValues() Clears this data object from all DataSets and removes all Entries.
boolean	contains(T dataSet) Checks if this data object contains the specified DataSet.
static java.util.List<java.lang.String>	generateXVals(int from, int to) Generates an x-values array filled with numbers in range specified by the parameters.
int[]	getColors() Returns all colors used across all DataSet objects this object represents.
T	getDataSetByIndex(int index)
T	getDataSetByLabel(java.lang.String label, boolean ignorecase) Returns the DataSet object with the given label.
int	getDataSetCount() returns the number of LineDataSets this object contains
T	getDataSetForEntry(Entry e) Returns the DataSet that contains the provided Entry, or null, if no DataSet contains this Entry.
protected int	getDataSetIndexByLabel(java.util.List<T> dataSets, java.lang.String label, boolean ignorecase) Retrieve the index of a DataSet with a specific label from the ChartData.
protected java.lang.String[]	getDataSetLabels() Returns the labels of all DataSets as a string array.
java.util.List<T>	getDataSets()
Entry	getEntryForHighlight(Highlight highlight) Get the Entry for a corresponding highlight object
T	getFirstLeft() Returns the first DataSet from the datasets-array that has it's dependency on the left axis.
T	getFirstRight() Returns the first DataSet from the datasets-array that has it's dependency on the right axis.
int	getIndexOfDataSet(T dataSet)
int	getXValCount() returns the total number of x-values this ChartData object represents (the size of the x-values array)
float	getXValMaximumLength() returns the maximum length (in characters) across all values in the x-vals array
java.util.List<java.lang.String>	getXVals() returns the x-values the chart represents
float	getYMax() Returns the greatest y-value the data object contains.
float	getYMax(YAxis.AxisDependency axis) Returns the maximum y-value for the specified axis.
float	getYMin() Returns the smallest y-value the data object contains.
float	getYMin(YAxis.AxisDependency axis) Returns the minimum y-value for the specified axis.
int	getYValCount() Returns the total number of y-values across all DataSet objects the this object represents.
protected void	init() performs all kinds of initialization calculations, such as min-max and value count and sum
boolean	isHighlightEnabled() Returns true if highlighting of all underlying values is enabled, false if not.
void	notifyDataChanged() Call this method to let the ChartData know that the underlying data has changed.
boolean	removeDataSet(int index) Removes the DataSet at the given index in the DataSet array from the data object.
boolean	removeDataSet(T d) Removes the given DataSet from this data object.
boolean	removeEntry(Entry e, int dataSetIndex) Removes the given Entry object from the DataSet at the specified index.
boolean	removeEntry(int xIndex, int dataSetIndex) Removes the Entry object at the given xIndex from the DataSet at the specified index.
void	removeXValue(int index) Removes the x-value at the specified index.
void	setDrawValues(boolean enabled) Enables / disables drawing values (value-text) for all DataSets this data object contains.
void	setHighlightEnabled(boolean enabled) Enables / disables highlighting values for all DataSets this data object contains.
void	setValueFormatter(ValueFormatter f) Sets a custom ValueFormatter for all DataSets this data object contains.
void	setValueTextColor(int color) Sets the color of the value-text (color in which the value-labels are drawn) for all DataSets this data object contains.
void	setValueTextColors(java.util.List<java.lang.Integer> colors) Sets the same list of value-colors for all DataSets this data object contains.
void	setValueTextSize(float size) Sets the size (in dp) of the value-text for all DataSets this data object contains.
void	setValueTypeface(android.graphics.Typeface tf) Sets the Typeface for all value-labels for all DataSets this data object contains.
void	setXVals(java.util.List<java.lang.String> xVals) sets the x-values the chart represents

Methods inherited from class java.lang.Object

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

Field Detail

mYMax

protected float mYMax

maximum y-value in the y-value array across all axes

mYMin

protected float mYMin

the minimum y-value in the y-value array across all axes

mLeftAxisMax

protected float mLeftAxisMax

mLeftAxisMin

protected float mLeftAxisMin

mRightAxisMax

protected float mRightAxisMax

mRightAxisMin

protected float mRightAxisMin

mXVals

protected java.util.List<java.lang.String> mXVals

holds all x-values the chart represents

mDataSets

protected java.util.List<T extends IDataSet<? extends Entry>> mDataSets

array that holds all DataSets the ChartData object represents

Constructor Detail

ChartData

public ChartData()

ChartData

public ChartData(java.util.List<java.lang.String> xVals)

Constructor for only x-values. This constructor can be used for setting up an empty chart without data.

Parameters:

xVals -

ChartData

public ChartData(java.lang.String[] xVals)

Constructor for only x-values. This constructor can be used for setting up an empty chart without data.

Parameters:

xVals -

ChartData

public ChartData(java.util.List<java.lang.String> xVals,
                 java.util.List<T> sets)

constructor for chart data

Parameters:

xVals - The values describing the x-axis. Must be at least as long as the highest xIndex in the Entry objects across all DataSets.

sets - the dataset array

ChartData

public ChartData(java.lang.String[] xVals,
                 java.util.List<T> sets)

constructor that takes string array instead of List string

Parameters:

xVals - The values describing the x-axis. Must be at least as long as the highest xIndex in the Entry objects across all DataSets.

sets - the dataset array

Method Detail

init

protected void init()

performs all kinds of initialization calculations, such as min-max and value count and sum

notifyDataChanged

public void notifyDataChanged()

Call this method to let the ChartData know that the underlying data has changed. Calling this performs all necessary recalculations needed when the contained data has changed.

calcMinMax

public void calcMinMax(int start,
                       int end)

calc minimum and maximum y value over all datasets

calcYValueCount

protected void calcYValueCount()

Calculates the total number of y-values across all DataSets the ChartData represents.

getDataSetCount

public int getDataSetCount()

returns the number of LineDataSets this object contains

Returns:

getYMin

public float getYMin()

Returns the smallest y-value the data object contains.

Returns:

getYMin

public float getYMin(YAxis.AxisDependency axis)

Returns the minimum y-value for the specified axis.

Parameters:

axis -

Returns:

getYMax

public float getYMax()

Returns the greatest y-value the data object contains.

Returns:

getYMax

public float getYMax(YAxis.AxisDependency axis)

Returns the maximum y-value for the specified axis.

Parameters:

axis -

Returns:

getXValMaximumLength

public float getXValMaximumLength()

returns the maximum length (in characters) across all values in the x-vals array

Returns:

getYValCount

public int getYValCount()

Returns the total number of y-values across all DataSet objects the this object represents.

Returns:

getXVals

public java.util.List<java.lang.String> getXVals()

returns the x-values the chart represents

Returns:

setXVals

public void setXVals(java.util.List<java.lang.String> xVals)

sets the x-values the chart represents

addXValue

public void addXValue(java.lang.String xVal)

Adds a new x-value to the chart data.

Parameters:

xVal -

removeXValue

public void removeXValue(int index)

Removes the x-value at the specified index.

Parameters:

index -

getDataSets

public java.util.List<T> getDataSets()

getDataSetIndexByLabel

protected int getDataSetIndexByLabel(java.util.List<T> dataSets,
                                     java.lang.String label,
                                     boolean ignorecase)

Retrieve the index of a DataSet with a specific label from the ChartData. Search can be case sensitive or not. IMPORTANT: This method does calculations at runtime, do not over-use in performance critical situations.

Parameters:

dataSets - the DataSet array to search

label -

ignorecase - if true, the search is not case-sensitive

Returns:

getXValCount

public int getXValCount()

returns the total number of x-values this ChartData object represents (the size of the x-values array)

Returns:

getDataSetLabels

protected java.lang.String[] getDataSetLabels()

Returns the labels of all DataSets as a string array.

Returns:

getEntryForHighlight

public Entry getEntryForHighlight(Highlight highlight)

Get the Entry for a corresponding highlight object

Parameters:

highlight -

Returns:

the entry that is highlighted

getDataSetByLabel

public T getDataSetByLabel(java.lang.String label,
                           boolean ignorecase)

Returns the DataSet object with the given label. Search can be case sensitive or not. IMPORTANT: This method does calculations at runtime. Use with care in performance critical situations.

Parameters:

label -

ignorecase -

Returns:

getDataSetByIndex

public T getDataSetByIndex(int index)

addDataSet

public void addDataSet(T d)

Adds a DataSet dynamically.

Parameters:

d -

removeDataSet

public boolean removeDataSet(T d)

Removes the given DataSet from this data object. Also recalculates all minimum and maximum values. Returns true if a DataSet was removed, false if no DataSet could be removed.

Parameters:

d -

removeDataSet

public boolean removeDataSet(int index)

Removes the DataSet at the given index in the DataSet array from the data object. Also recalculates all minimum and maximum values. Returns true if a DataSet was removed, false if no DataSet could be removed.

Parameters:

index -

addEntry

public void addEntry(Entry e,
                     int dataSetIndex)

Adds an Entry to the DataSet at the specified index. Entries are added to the end of the list.

Parameters:

e -

dataSetIndex -

removeEntry

public boolean removeEntry(Entry e,
                           int dataSetIndex)

Removes the given Entry object from the DataSet at the specified index.

Parameters:

e -

dataSetIndex -

removeEntry

public boolean removeEntry(int xIndex,
                           int dataSetIndex)

Removes the Entry object at the given xIndex from the DataSet at the specified index. Returns true if an Entry was removed, false if no Entry was found that meets the specified requirements.

Parameters:

xIndex -

dataSetIndex -

Returns:

getDataSetForEntry

public T getDataSetForEntry(Entry e)

Returns the DataSet that contains the provided Entry, or null, if no DataSet contains this Entry.

Parameters:

e -

Returns:

getColors

public int[] getColors()

Returns all colors used across all DataSet objects this object represents.

Returns:

getIndexOfDataSet

public int getIndexOfDataSet(T dataSet)

getFirstLeft

public T getFirstLeft()

Returns the first DataSet from the datasets-array that has it's dependency on the left axis. Returns null if no DataSet with left dependency could be found.

Returns:

getFirstRight

public T getFirstRight()

Returns the first DataSet from the datasets-array that has it's dependency on the right axis. Returns null if no DataSet with right dependency could be found.

Returns:

generateXVals

public static java.util.List<java.lang.String> generateXVals(int from,
                                                             int to)

Generates an x-values array filled with numbers in range specified by the parameters. Can be used for convenience.

Returns:

setValueFormatter

public void setValueFormatter(ValueFormatter f)

Sets a custom ValueFormatter for all DataSets this data object contains.

Parameters:

f -

setValueTextColor

public void setValueTextColor(int color)

Sets the color of the value-text (color in which the value-labels are drawn) for all DataSets this data object contains.

Parameters:

color -

setValueTextColors

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

Sets the same list of value-colors for all DataSets this data object contains.

Parameters:

colors -

setValueTypeface

public void setValueTypeface(android.graphics.Typeface tf)

Sets the Typeface for all value-labels for all DataSets this data object contains.

Parameters:

tf -

setValueTextSize

public void setValueTextSize(float size)

Sets the size (in dp) of the value-text for all DataSets this data object contains.

Parameters:

size -

setDrawValues

public void setDrawValues(boolean enabled)

Enables / disables drawing values (value-text) for all DataSets this data object contains.

Parameters:

enabled -

setHighlightEnabled

public void setHighlightEnabled(boolean enabled)

Enables / disables highlighting values for all DataSets this data object contains. If set to true, this means that values can be highlighted programmatically or by touch gesture.

isHighlightEnabled

public boolean isHighlightEnabled()

Returns true if highlighting of all underlying values is enabled, false if not.

Returns:

clearValues

public void clearValues()

Clears this data object from all DataSets and removes all Entries. Don't forget to invalidate the chart after this.

contains

public boolean contains(T dataSet)

Checks if this data object contains the specified DataSet. Returns true if so, false if not.

Parameters:

dataSet -

Returns: