DataSet (MPChartLib v2.1.6 API)

java.lang.Object
- com.github.mikephil.charting.data.DataSet<T>

Direct Known Subclasses:

BarLineScatterCandleBubbleDataSet, PieDataSet
```
public abstract class DataSet<T extends Entry>
extends java.lang.Object
```
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).

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 int`	`mLastEnd` the last end value used for calcMinMax
`protected int`	`mLastStart` the last start value used for calcMinMax
`protected ValueFormatter`	`mValueFormatter` custom formatter that is used instead of the auto-formatter if set
`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

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.

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

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColor(int color)` Adds a new color to the colors array of the DataSet.
`void`	`addEntry(Entry e)` Adds an Entry to the DataSet dynamically.
`void`	`addEntryOrdered(Entry e)` Adds an Entry to the DataSet dynamically.
`protected void`	`calcMinMax(int start, int end)` calc minimum and maximum y value
`void`	`clear()` Removes all values from this DataSet and recalculates min and max value.
`boolean`	`contains(Entry e)` Checks if this DataSet contains the specified Entry.
`abstract DataSet<T>`	`copy()` Provides an exact copy of the DataSet this method is used on.
`float`	`getAverage()` Returns the average value across all entries in this DataSet.
`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()` returns all the colors that are set for this DataSet
`java.util.List<T>`	`getEntriesForXIndex(int x)` Returns all Entry objects at the given xIndex.
`int`	`getEntryCount()` returns the number of y-values this DataSet represents
`T`	`getEntryForXIndex(int x)` Returns the first Entry object found at the given xIndex with binary search.
`int`	`getEntryIndex(int x)` Returns the first Entry index found at the given xIndex with binary search.
`int`	`getEntryPosition(Entry e)` Returns the position of the provided entry in the DataSets Entry array.
`int`	`getIndexInEntries(int xIndex)` The xIndex of an Entry object is provided.
`java.lang.String`	`getLabel()` Returns the label string that describes the DataSet.
`int`	`getValueCount()` Returns the number of entries this DataSet holds.
`ValueFormatter`	`getValueFormatter()` Returns the formatter used for drawing the values inside the chart.
`int`	`getValueTextColor()`
`float`	`getValueTextSize()` Returns the text-size of the labels that are displayed above the values.
`android.graphics.Typeface`	`getValueTypeface()`
`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 DataSets Entry array
`float`	`getYValueSum()` gets the sum of all y-values
`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.
`boolean`	`needsDefaultFormatter()` If this component has no ValueFormatter or is only equipped with the default one (no custom set), return true.
`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`	`removeEntry(T e)` Removes an Entry from the DataSets entries array.
`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`	`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(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)` Sets the label string that describes the DataSet.
`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`	`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.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - mColors
```
protected java.util.List<java.lang.Integer> mColors
```
    List representing all colors that are used for this DataSet
  - 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
  - mLastStart
```
protected int mLastStart
```
    the last start value used for calcMinMax
  - mLastEnd
```
protected int mLastEnd
```
    the last end value used for calcMinMax
  - mDrawValues
```
protected boolean mDrawValues
```
    if true, y-values are drawn on the chart
  - mValueFormatter
```
protected transient ValueFormatter mValueFormatter
```
    custom formatter that is used instead of the auto-formatter if set
  - 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
- 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
  - notifyDataSetChanged
```
public void notifyDataSetChanged()
```
    Use this method to tell the data set that the underlying data has changed
  - calcMinMax
```
protected void calcMinMax(int start,
                          int end)
```
    calc minimum and maximum y value
  - getAverage
```
public float getAverage()
```
    Returns the average value across all entries in this DataSet.
    
    Returns:
  - getEntryCount
```
public int getEntryCount()
```
    returns the number of y-values this DataSet represents
    
    Returns:
  - getYValForXIndex
```
public float getYValForXIndex(int xIndex)
```
    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.
    
    Parameters:
    
    xIndex -
    
    Returns:
  - getEntryForXIndex
```
public T getEntryForXIndex(int x)
```
    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.
    
    Parameters:
    
    x -
    
    Returns:
  - getEntryIndex
```
public int getEntryIndex(int x)
```
    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.
    
    Parameters:
    
    x -
    
    Returns:
  - getEntriesForXIndex
```
public java.util.List<T> getEntriesForXIndex(int x)
```
    Returns all Entry objects at the given xIndex. INFORMATION: This method does calculations at runtime. Do not over-use in performance critical situations.
    
    Parameters:
    
    x -
    
    Returns:
  - getYVals
```
public java.util.List<T> getYVals()
```
    returns the DataSets Entry array
    
    Returns:
  - getYValueSum
```
public float getYValueSum()
```
    gets the sum of all y-values
    
    Returns:
  - getYMin
```
public float getYMin()
```
    returns the minimum y-value this DataSet holds
    
    Returns:
  - getYMax
```
public float getYMax()
```
    returns the maximum y-value this DataSet holds
    
    Returns:
  - getValueCount
```
public int getValueCount()
```
    Returns the number of entries this DataSet holds.
    
    Returns:
  - getIndexInEntries
```
public int getIndexInEntries(int xIndex)
```
    The xIndex of an Entry object is provided. This method returns the actual index in the Entry array of the DataSet. IMPORTANT: This method does calculations at runtime, do not over-use in performance critical situations.
    
    Parameters:
    
    xIndex -
    
    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:
  - setLabel
```
public void setLabel(java.lang.String label)
```
    Sets the label string that describes the DataSet.
  - getLabel
```
public java.lang.String getLabel()
```
    Returns the label string that describes the DataSet.
    
    Returns:
  - setVisible
```
public void setVisible(boolean visible)
```
    Set the visibility of this DataSet. If not visible, the DataSet will not be drawn to the chart upon refreshing it.
    
    Parameters:
    
    visible -
  - isVisible
```
public boolean isVisible()
```
    Returns true if this DataSet is visible inside the chart, or false if it is currently hidden.
    
    Returns:
  - getAxisDependency
```
public YAxis.AxisDependency getAxisDependency()
```
    Returns the axis this DataSet should be plotted against.
    
    Returns:
  - setAxisDependency
```
public void setAxisDependency(YAxis.AxisDependency dependency)
```
    Set the y-axis this DataSet should be plotted against (either LEFT or RIGHT). Default: LEFT
    
    Parameters:
    
    dependency -
  - setDrawValues
```
public 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
    
    Parameters:
    
    enabled -
  - isDrawValuesEnabled
```
public boolean isDrawValuesEnabled()
```
    returns true if y-value drawing is enabled, false if not
    
    Returns:
  - addEntry
```
public void addEntry(Entry e)
```
    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.
    
    Parameters:
    
    e -
  - addEntryOrdered
```
public void addEntryOrdered(Entry e)
```
    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.
    
    Parameters:
    
    e -
  - removeEntry
```
public boolean removeEntry(T e)
```
    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.
    
    Parameters:
    
    e -
  - removeEntry
```
public boolean removeEntry(int xIndex)
```
    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.
    
    Parameters:
    
    xIndex -
  - removeFirst
```
public boolean removeFirst()
```
    Removes the first Entry (at index 0) of this DataSet from the entries array. Returns true if successful, false if not.
    
    Returns:
  - removeLast
```
public boolean removeLast()
```
    Removes the last Entry (at index size-1) of this DataSet from the entries array. Returns true if successful, false if not.
    
    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 -
  - getColors
```
public java.util.List<java.lang.Integer> getColors()
```
    returns all the colors that are set for this DataSet
    
    Returns:
  - getColor
```
public int getColor(int index)
```
    Returns the color at the given index of the DataSet's color array. Performs a IndexOutOfBounds check by modulus.
    
    Parameters:
    
    index -
    
    Returns:
  - getColor
```
public int getColor()
```
    Returns the first color (index 0) of the colors-array this DataSet contains.
    
    Returns:
  - resetColors
```
public void resetColors()
```
    Resets all colors of this DataSet and recreates the colors array.
  - setHighlightEnabled
```
public void setHighlightEnabled(boolean enabled)
```
    If set to true, value highlighting is enabled which means that values can be highlighted programmatically or by touch gesture.
    
    Parameters:
    
    enabled -
  - isHighlightEnabled
```
public boolean isHighlightEnabled()
```
    returns true if highlighting of values is enabled, false if not
    
    Returns:
  - getEntryPosition
```
public int getEntryPosition(Entry e)
```
    Returns the position of the provided entry in the DataSets Entry array. Returns -1 if doesn't exist.
    
    Parameters:
    
    e -
    
    Returns:
  - setValueFormatter
```
public void setValueFormatter(ValueFormatter f)
```
    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.
    
    Parameters:
    
    f -
  - getValueFormatter
```
public ValueFormatter getValueFormatter()
```
    Returns the formatter used for drawing the values inside the chart.
    
    Returns:
  - needsDefaultFormatter
```
public boolean needsDefaultFormatter()
```
    If this component has no ValueFormatter or is only equipped with the default one (no custom set), return true.
    
    Returns:
  - setValueTextColor
```
public void setValueTextColor(int color)
```
    Sets the color the value-labels of this DataSet should have.
    
    Parameters:
    
    color -
  - getValueTextColor
```
public int getValueTextColor()
```
  - setValueTypeface
```
public void setValueTypeface(android.graphics.Typeface tf)
```
    Sets a Typeface for the value-labels of this DataSet.
    
    Parameters:
    
    tf -
  - getValueTypeface
```
public android.graphics.Typeface getValueTypeface()
```
  - setValueTextSize
```
public void setValueTextSize(float size)
```
    Sets the text-size of the value-labels of this DataSet in dp.
    
    Parameters:
    
    size -
  - getValueTextSize
```
public float getValueTextSize()
```
    Returns the text-size of the labels that are displayed above the values.
    
    Returns:
  - contains
```
public boolean contains(Entry e)
```
    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.
    
    Parameters:
    
    e -
    
    Returns:
  - clear
```
public void clear()
```
    Removes all values from this DataSet and recalculates min and max value.

Class DataSet<T extends Entry>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mColors

mYVals

mYMax

mYMin

mLastStart

mLastEnd

mDrawValues

mValueFormatter

mAxisDependency

mHighlightEnabled

Constructor Detail

DataSet

Method Detail

notifyDataSetChanged

calcMinMax

getAverage

getEntryCount

getYValForXIndex

getEntryForXIndex

getEntryIndex

getEntriesForXIndex

getYVals

getYValueSum

getYMin

getYMax

getValueCount

getIndexInEntries

copy

toString

toSimpleString

setLabel

getLabel

setVisible

isVisible

getAxisDependency

setAxisDependency

setDrawValues

isDrawValuesEnabled

addEntry

addEntryOrdered

removeEntry

removeEntry

removeFirst

removeLast

setColors

setColors

setColors

addColor

setColor

getColors

getColor

getColor

resetColors

setHighlightEnabled

isHighlightEnabled

getEntryPosition

setValueFormatter

getValueFormatter

needsDefaultFormatter

setValueTextColor

getValueTextColor

setValueTypeface

getValueTypeface

setValueTextSize

getValueTextSize

contains

clear