com.github.mikephil.charting.data

Class DataSet<T extends Entry>

java.lang.Object

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

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

All Implemented Interfaces:

IDataSet<T>

Direct Known Subclasses:

BarLineScatterCandleBubbleDataSet, PieDataSet

public abstract class DataSet<T extends Entry>
extends BaseDataSet<T>

The DataSet class represents one group or type of entries (Entry) in the Chart that belong together. It is designed to logically separate different groups of values inside the Chart (e.g. the values for a specific line in the LineChart, or the values of a specific group of bars in the BarChart).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSet.Rounding Determines how to round DataSet index values for getEntryIndex(float, float, Rounding) DataSet.getEntryIndex()} when an exact x-index is not found.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<T>	mValues the entries that this DataSet represents / holds together
protected float	mXMax maximum x-value in the value array
protected float	mXMin minimum x-value in the value array
protected float	mYMax maximum y-value in the value array
protected float	mYMin minimum y-value in the value array

Fields inherited from class com.github.mikephil.charting.data.BaseDataSet

mAxisDependency, mColors, mDrawIcons, mDrawValues, mGradientColor, mGradientColors, mHighlightEnabled, mIconsOffset, mValueColors, mValueFormatter, mValueTextSize, mValueTypeface, mVisible

Constructor Summary

Constructors

Constructor and Description
DataSet(java.util.List<T> values, java.lang.String label) Creates a new DataSet object with the given values (entries) it represents.

Method Summary

Modifier and Type	Method and Description
boolean	addEntry(T e) Adds an Entry to the DataSet dynamically.
void	addEntryOrdered(T e) Adds an Entry to the DataSet dynamically.
void	calcMinMax() Calculates the minimum and maximum x and y values (mXMin, mXMax, mYMin, mYMax).
protected void	calcMinMax(T e) Updates the min and max x and y value of this DataSet based on the given Entry.
protected void	calcMinMaxX(T e)
void	calcMinMaxY(float fromX, float toX) Calculates the min and max y-values from the Entry closest to the given fromX to the Entry closest to the given toX value.
protected void	calcMinMaxY(T e)
void	clear() Removes all values from this DataSet and does all necessary recalculations.
abstract DataSet<T>	copy() Provides an exact copy of the DataSet this method is used on.
protected void	copy(DataSet dataSet)
java.util.List<T>	getEntriesForXValue(float xValue) Returns all Entry objects found at the given x-value with binary search.
int	getEntryCount() Returns the number of y-values this DataSet represents -> the size of the y-values array -> yvals.size()
T	getEntryForIndex(int index) Returns the Entry object found at the given index (NOT xIndex) in the values array.
T	getEntryForXValue(float xValue, float closestToY) Returns the first Entry object found at the given x-value with binary search.
T	getEntryForXValue(float xValue, float closestToY, DataSet.Rounding rounding) Returns the first Entry object found at the given x-value with binary search.
int	getEntryIndex(Entry e) Returns the position of the provided entry in the DataSets Entry array.
int	getEntryIndex(float xValue, float closestToY, DataSet.Rounding rounding) Returns the first Entry index found at the given x-value with binary search.
java.util.List<T>	getValues() Returns the array of entries that this DataSet represents.
float	getXMax() returns the maximum x-value this DataSet holds
float	getXMin() returns the minimum x-value this DataSet holds
float	getYMax() returns the maximum y-value this DataSet holds
float	getYMin() returns the minimum y-value this DataSet holds
boolean	removeEntry(T e) Removes an Entry from the DataSets entries array.
void	setValues(java.util.List<T> values) Sets the array of entries that this DataSet represents, and calls notifyDataSetChanged()
java.lang.String	toSimpleString() Returns a simple string representation of the DataSet with the type and the number of Entries.
java.lang.String	toString()

Methods inherited from class com.github.mikephil.charting.data.BaseDataSet

addColor, contains, copy, getAxisDependency, getColor, getColor, getColors, getForm, getFormLineDashEffect, getFormLineWidth, getFormSize, getGradientColor, getGradientColor, getGradientColors, getIconsOffset, getIndexInEntries, getLabel, getValueColors, getValueFormatter, getValueTextColor, getValueTextColor, getValueTextSize, getValueTypeface, isDrawIconsEnabled, isDrawValuesEnabled, isHighlightEnabled, isVisible, needsFormatter, notifyDataSetChanged, removeEntry, removeEntryByXValue, removeFirst, removeLast, resetColors, setAxisDependency, setColor, setColor, setColors, setColors, setColors, setColors, setDrawIcons, setDrawValues, setForm, setFormLineDashEffect, setFormLineWidth, setFormSize, setGradientColor, setGradientColors, setHighlightEnabled, setIconsOffset, setLabel, setValueFormatter, setValueTextColor, setValueTextColors, setValueTextSize, setValueTypeface, setVisible

Methods inherited from class java.lang.Object

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

Field Detail

mValues

protected java.util.List<T extends Entry> mValues

the entries that this DataSet represents / holds together

mYMax

protected float mYMax

maximum y-value in the value array

mYMin

protected float mYMin

minimum y-value in the value array

mXMax

protected float mXMax

maximum x-value in the value array

mXMin

protected float mXMin

minimum x-value in the value array

Constructor Detail

DataSet

public DataSet(java.util.List<T> values,
               java.lang.String label)

Creates a new DataSet object with the given values (entries) it represents. Also, a label that describes the DataSet can be specified. The label can also be used to retrieve the DataSet from a ChartData object.

Parameters:

values -

label -

Method Detail

calcMinMax

public void calcMinMax()

Description copied from interface: IDataSet

Calculates the minimum and maximum x and y values (mXMin, mXMax, mYMin, mYMax).

calcMinMaxY

public void calcMinMaxY(float fromX,
                        float toX)

Description copied from interface: IDataSet

Calculates the min and max y-values from the Entry closest to the given fromX to the Entry closest to the given toX value. This is only needed for the autoScaleMinMax feature.

calcMinMax

protected void calcMinMax(T e)

Updates the min and max x and y value of this DataSet based on the given Entry.

Parameters:

e -

calcMinMaxX

protected void calcMinMaxX(T e)

calcMinMaxY

protected void calcMinMaxY(T e)

getEntryCount

public int getEntryCount()

Description copied from interface: IDataSet

Returns the number of y-values this DataSet represents -> the size of the y-values array -> yvals.size()

Returns:

getValues

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

Returns the array of entries that this DataSet represents.

Returns:

setValues

public void setValues(java.util.List<T> values)

Sets the array of entries that this DataSet represents, and calls notifyDataSetChanged()

copy

public abstract DataSet<T> copy()

Provides an exact copy of the DataSet this method is used on.

Returns:

copy

protected void copy(DataSet dataSet)

Parameters:

dataSet -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toSimpleString

public java.lang.String toSimpleString()

Returns a simple string representation of the DataSet with the type and the number of Entries.

Returns:

getYMin

public float getYMin()

Description copied from interface: IDataSet

returns the minimum y-value this DataSet holds

Returns:

getYMax

public float getYMax()

Description copied from interface: IDataSet

returns the maximum y-value this DataSet holds

Returns:

getXMin

public float getXMin()

Description copied from interface: IDataSet

returns the minimum x-value this DataSet holds

Returns:

getXMax

public float getXMax()

Description copied from interface: IDataSet

returns the maximum x-value this DataSet holds

Returns:

addEntryOrdered

public void addEntryOrdered(T e)

Description copied from interface: IDataSet

Adds an Entry to the DataSet dynamically. Entries are added to their appropriate index in the values array respective to their x-position. This will also recalculate the current minimum and maximum values of the DataSet and the value-sum.

clear

public void clear()

Description copied from interface: IDataSet

Removes all values from this DataSet and does all necessary recalculations.

addEntry

public boolean addEntry(T e)

Description copied from interface: IDataSet

Adds an Entry to the DataSet dynamically. Entries are added to the end of the list. This will also recalculate the current minimum and maximum values of the DataSet and the value-sum.

removeEntry

public boolean removeEntry(T e)

Description copied from interface: IDataSet

Removes an Entry from the DataSets entries array. This will also recalculate the current minimum and maximum values of the DataSet and the value-sum. Returns true if an Entry was removed, false if no Entry could be removed.

getEntryIndex

public int getEntryIndex(Entry e)

Description copied from interface: IDataSet

Returns the position of the provided entry in the DataSets Entry array. Returns -1 if doesn't exist.

Returns:

getEntryForXValue

public T getEntryForXValue(float xValue,
                           float closestToY,
                           DataSet.Rounding rounding)

Description copied from interface: IDataSet

Returns the first Entry object found at the given x-value with binary search. If the no Entry at the specified x-value is found, this method returns the Entry at the closest x-value according to the rounding. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

Parameters:

xValue - the x-value

closestToY - If there are multiple y-values for the specified x-value,

rounding - determine whether to round up/down/closest if there is no Entry matching the provided x-value

Returns:

getEntryForXValue

public T getEntryForXValue(float xValue,
                           float closestToY)

Description copied from interface: IDataSet

Returns the first Entry object found at the given x-value with binary search. If the no Entry at the specified x-value is found, this method returns the Entry at the closest x-value. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

Parameters:

xValue - the x-value

closestToY - If there are multiple y-values for the specified x-value,

Returns:

getEntryForIndex

public T getEntryForIndex(int index)

Description copied from interface: IDataSet

Returns the Entry object found at the given index (NOT xIndex) in the values array.

Returns:

getEntryIndex

public int getEntryIndex(float xValue,
                         float closestToY,
                         DataSet.Rounding rounding)

Description copied from interface: IDataSet

Returns the first Entry index found at the given x-value with binary search. If the no Entry at the specified x-value is found, this method returns the Entry at the closest x-value according to the rounding. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

Parameters:

xValue - the x-value

closestToY - If there are multiple y-values for the specified x-value,

rounding - determine whether to round up/down/closest if there is no Entry matching the provided x-value

Returns:

getEntriesForXValue

public java.util.List<T> getEntriesForXValue(float xValue)

Description copied from interface: IDataSet

Returns all Entry objects found at the given x-value with binary search. An empty array if no Entry object at that x-value. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

Returns: