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(int, Rounding) DataSet.getEntryIndex()} when an exact x-index is not found.

Field Summary

Fields

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

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

mAxisDependency, mColors, mDrawValues, mHighlightEnabled, mValueColors, mValueFormatter, mValueTextSize, mValueTypeface, mVisible

Constructor Summary

Constructors

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

Method Summary

Methods

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(int start, int end) Calculates the minimum and maximum y value (mYMin, mYMax).
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.
java.util.List<T>	getEntriesForXIndex(int xIndex) Returns all Entry objects at the given xIndex.
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	getEntryForXIndex(int xIndex) Returns the first Entry object found at the given xIndex with binary search.
T	getEntryForXIndex(int xIndex, DataSet.Rounding rounding) Returns the first Entry object found at the given xIndex with binary search.
int	getEntryIndex(Entry e) Returns the position of the provided entry in the DataSets Entry array.
int	getEntryIndex(int xIndex, DataSet.Rounding rounding) Returns the first Entry index found at the given xIndex with binary search.
float	getYMax() returns the maximum y-value this DataSet holds
float	getYMin() returns the minimum y-value this DataSet holds
float	getYValForXIndex(int xIndex) Returns the value of the Entry object at the given xIndex.
java.util.List<T>	getYVals() Returns the array of y-values that this DataSet represents.
boolean	removeEntry(T e) Removes an Entry from the DataSets entries array.
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, getAxisDependency, getColor, getColor, getColors, getIndexInEntries, getLabel, getValueFormatter, getValueTextColor, getValueTextColor, getValueTextSize, getValueTypeface, isDrawValuesEnabled, isHighlightEnabled, isVisible, notifyDataSetChanged, removeEntry, removeFirst, removeLast, resetColors, setAxisDependency, setColor, setColor, setColors, setColors, setColors, setColors, setDrawValues, setHighlightEnabled, 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

mYVals

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

the entries that this dataset represents / holds together

mYMax

protected float mYMax

maximum y-value in the y-value array

mYMin

protected float mYMin

the minimum y-value in the y-value array

Constructor Detail

DataSet

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

Creates a new DataSet object with the given values 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:

yVals -

label -

Method Detail

calcMinMax

public void calcMinMax(int start,
              int end)

Description copied from interface: IDataSet

Calculates the minimum and maximum y value (mYMin, mYMax). From the specified starting to ending index.

Parameters:

start - starting index in your data list

end - ending index in your data list

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:

getYVals

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

Returns the array of y-values that this DataSet represents.

Returns:

copy

public abstract DataSet<T> copy()

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

Returns:

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:

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 respective to it's x-index. 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:

getEntryForXIndex

public T getEntryForXIndex(int xIndex,
                  DataSet.Rounding rounding)

Description copied from interface: IDataSet

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

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

Returns:

getEntryForXIndex

public T getEntryForXIndex(int xIndex)

Description copied from interface: IDataSet

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

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(int xIndex,
                DataSet.Rounding rounding)

Description copied from interface: IDataSet

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

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

Returns:

getYValForXIndex

public float getYValForXIndex(int xIndex)

Description copied from interface: IDataSet

Returns the value of the Entry object at the given xIndex. Returns Float.NaN if no value is at the given x-index. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

Returns:

getEntriesForXIndex

public java.util.List<T> getEntriesForXIndex(int xIndex)

Returns all Entry objects at the given xIndex. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.

Parameters:

xIndex -

Returns: