com.github.mikephil.charting.interfaces.datasets

Interface IDataSet<T extends Entry>

All Known Subinterfaces:

IBarDataSet, IBarLineScatterCandleBubbleDataSet<T>, IBubbleDataSet, ICandleDataSet, ILineDataSet, ILineRadarDataSet<T>, ILineScatterCandleRadarDataSet<T>, IPieDataSet, IRadarDataSet, IScatterDataSet

All Known Implementing Classes:

BarDataSet, BarLineScatterCandleBubbleDataSet, BaseDataSet, BubbleDataSet, CandleDataSet, DataSet, LineDataSet, LineRadarDataSet, LineScatterCandleRadarDataSet, PieDataSet, RadarDataSet, RealmBarDataSet, RealmBarLineScatterCandleBubbleDataSet, RealmBaseDataSet, RealmBubbleDataSet, RealmCandleDataSet, RealmLineDataSet, RealmLineRadarDataSet, RealmLineScatterCandleRadarDataSet, RealmPieDataSet, RealmRadarDataSet, RealmScatterDataSet, ScatterDataSet

public interface IDataSet<T extends Entry>

Created by Philipp Jahoda on 21/10/15.

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(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.
boolean	contains(T entry) 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() returns all the colors that are set for this DataSet
java.util.List<T>	getEntriesForXIndex(int xIndex) Returns all Entry objects found at the given xIndex 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	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(int xIndex, DataSet.Rounding rounding) Returns the first Entry index found at the given xIndex with binary search.
int	getEntryIndex(T e) Returns the position of the provided entry in the DataSets Entry array.
int	getIndexInEntries(int xIndex) This method returns the actual index in the Entry array of the DataSet for a given xIndex.
java.lang.String	getLabel() Returns the label string that describes the DataSet.
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
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.
float[]	getYValsForXIndex(int xIndex) Returns all of the y values of the Entry objects at the given xIndex.
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	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	setAxisDependency(YAxis.AxisDependency dependency) Set the y-axis this DataSet should be plotted against (either LEFT or RIGHT).
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	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.

Method Detail

getYMin

float getYMin()

returns the minimum y-value this DataSet holds

Returns:

getYMax

float getYMax()

returns the maximum y-value this DataSet holds

Returns:

getEntryCount

int getEntryCount()

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

Returns:

calcMinMax

void calcMinMax(int start,
                int end)

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

getEntryForXIndex

T getEntryForXIndex(int xIndex,
                    DataSet.Rounding rounding)

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:

xIndex -

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

Returns:

getEntryForXIndex

T getEntryForXIndex(int xIndex)

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:

xIndex -

Returns:

getEntriesForXIndex

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

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

Parameters:

xIndex -

Returns:

getEntryForIndex

T getEntryForIndex(int index)

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

Parameters:

index -

Returns:

getEntryIndex

int getEntryIndex(int xIndex,
                  DataSet.Rounding rounding)

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:

xIndex -

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

Returns:

getEntryIndex

int getEntryIndex(T e)

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

Parameters:

e -

Returns:

getYValForXIndex

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:

getYValsForXIndex

float[] getYValsForXIndex(int xIndex)

Returns all of the y values of the Entry objects 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:

getIndexInEntries

int getIndexInEntries(int xIndex)

This method returns the actual index in the Entry array of the DataSet for a given xIndex. IMPORTANT: This method does calculations at runtime, do not over-use in performance critical situations.

Parameters:

xIndex -

Returns:

addEntry

boolean addEntry(T 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 -

removeEntry

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 -

addEntryOrdered

void addEntryOrdered(T 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 -

removeFirst

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

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:

removeEntry

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 -

contains

boolean contains(T entry)

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:

entry -

Returns:

clear

void clear()

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

getLabel

java.lang.String getLabel()

Returns the label string that describes the DataSet.

Returns:

setLabel

void setLabel(java.lang.String label)

Sets the label string that describes the DataSet.

Parameters:

label -

getAxisDependency

YAxis.AxisDependency getAxisDependency()

Returns the axis this DataSet should be plotted against.

Returns:

setAxisDependency

void setAxisDependency(YAxis.AxisDependency dependency)

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

Parameters:

dependency -

getColors

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

returns all the colors that are set for this DataSet

Returns:

getColor

int getColor()

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)

Returns:

getColor

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:

isHighlightEnabled

boolean isHighlightEnabled()

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

Returns:

setHighlightEnabled

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 -

setValueFormatter

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

ValueFormatter getValueFormatter()

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

Returns:

setValueTextColor

void setValueTextColor(int color)

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

Parameters:

color -

setValueTextColors

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

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

Parameters:

colors -

setValueTypeface

void setValueTypeface(android.graphics.Typeface tf)

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

Parameters:

tf -

setValueTextSize

void setValueTextSize(float size)

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

Parameters:

size -

getValueTextColor

int getValueTextColor()

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

Returns:

getValueTextColor

int getValueTextColor(int index)

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

Parameters:

index -

Returns:

getValueTypeface

android.graphics.Typeface getValueTypeface()

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

Returns:

getValueTextSize

float getValueTextSize()

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

Returns:

setDrawValues

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

boolean isDrawValuesEnabled()

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

Returns:

setVisible

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

boolean isVisible()

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

Returns: