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, 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() Calculates the minimum and maximum x and y values (mXMin, mXMax, mYMin, mYMax).
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.
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>	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(float xValue, float closestToY, DataSet.Rounding rounding) Returns the first Entry index found at the given x-value with binary search.
int	getEntryIndex(T e) Returns the position of the provided entry in the DataSets Entry array.
Legend.LegendForm	getForm() The form to draw for this dataset in the legend.
android.graphics.DashPathEffect	getFormLineDashEffect() The line dash path effect used for shapes that consist of lines.
float	getFormLineWidth() The line width for drawing the form of this dataset in the legend Return `Float.NaN` to use the default legend form line width.
float	getFormSize() The form size to draw for this dataset in the legend.
GradientColor	getGradientColor() Returns the Gradient color model
GradientColor	getGradientColor(int index) Returns the Gradient colors
java.util.List<GradientColor>	getGradientColors() Returns the Gradient colors
MPPointF	getIconsOffset() Get the offset for drawing icons.
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	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	isDrawIconsEnabled() Returns true if y-icon drawing is enabled, false if not
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	needsFormatter() Returns true if the valueFormatter object of this DataSet is null.
boolean	removeEntry(int index) Removes the Entry object at the given index in the values array from the DataSet.
boolean	removeEntry(T e) Removes an Entry from the DataSets entries array.
boolean	removeEntryByXValue(float xValue) Removes the Entry object closest to the given x-value from the DataSet.
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	setDrawIcons(boolean enabled) Set this to true to draw y-icons on the chart.
void	setDrawValues(boolean enabled) set this to true to draw y-values on the chart.
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	setIconsOffset(MPPointF offset) Offset of icons drawn on the chart.
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:

getXMin

float getXMin()

returns the minimum x-value this DataSet holds

Returns:

getXMax

float getXMax()

returns the maximum x-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()

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

calcMinMaxY

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. This is only needed for the autoScaleMinMax feature.

Parameters:

fromX -

toX -

getEntryForXValue

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

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

T getEntryForXValue(float xValue,
                    float closestToY)

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:

getEntriesForXValue

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

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.

Parameters:

xValue -

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(float xValue,
                  float closestToY,
                  DataSet.Rounding rounding)

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:

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:

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 -

addEntryOrdered

void addEntryOrdered(T e)

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.

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(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 -

removeEntryByXValue

boolean removeEntryByXValue(float xValue)

Removes the Entry object closest to the given x-value from the DataSet. Returns true if an Entry was removed, false if no Entry could be removed.

Parameters:

xValue -

removeEntry

boolean removeEntry(int index)

Removes the Entry object at the given index in the values array from the DataSet. Returns true if an Entry was removed, false if no Entry could be removed.

Parameters:

index -

Returns:

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:

getGradientColor

GradientColor getGradientColor()

Returns the Gradient color model

Returns:

getGradientColors

java.util.List<GradientColor> getGradientColors()

Returns the Gradient colors

Returns:

getGradientColor

GradientColor getGradientColor(int index)

Returns the Gradient colors

Parameters:

index -

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:

needsFormatter

boolean needsFormatter()

Returns true if the valueFormatter object of this DataSet is null.

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:

getForm

Legend.LegendForm getForm()

The form to draw for this dataset in the legend.

Return `DEFAULT` to use the default legend form.

getFormSize

float getFormSize()

The form size to draw for this dataset in the legend.

Return `Float.NaN` to use the default legend form size.

getFormLineWidth

float getFormLineWidth()

The line width for drawing the form of this dataset in the legend

Return `Float.NaN` to use the default legend form line width.

getFormLineDashEffect

android.graphics.DashPathEffect getFormLineDashEffect()

The line dash path effect used for shapes that consist of lines.

Return `null` to use the default legend form line dash effect.

setDrawValues

void setDrawValues(boolean enabled)

set this to true to draw y-values on the chart. NOTE (for bar and line charts): 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:

setDrawIcons

void setDrawIcons(boolean enabled)

Set this to true to draw y-icons on the chart. NOTE (for bar and line charts): if `maxVisibleCount` is reached, no icons will be drawn even if this is enabled

Parameters:

enabled -

isDrawIconsEnabled

boolean isDrawIconsEnabled()

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

Returns:

setIconsOffset

void setIconsOffset(MPPointF offset)

Offset of icons drawn on the chart. For all charts except Pie and Radar it will be ordinary (x offset,y offset). For Pie and Radar chart it will be (y offset, distance from center offset); so if you want icon to be rendered under value, you should increase X component of CGPoint, and if you want icon to be rendered closet to center, you should decrease height component of CGPoint.

Parameters:

offset -

getIconsOffset

MPPointF getIconsOffset()

Get the offset for drawing icons.

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: