com.github.mikephil.charting.data

Class CandleDataSet

java.lang.Object

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

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

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

com.github.mikephil.charting.data.LineScatterCandleRadarDataSet<CandleEntry>

com.github.mikephil.charting.data.CandleDataSet

All Implemented Interfaces:

IBarLineScatterCandleBubbleDataSet<CandleEntry>, ICandleDataSet, IDataSet<CandleEntry>, ILineScatterCandleRadarDataSet<CandleEntry>

public class CandleDataSet
extends LineScatterCandleRadarDataSet<CandleEntry>
implements ICandleDataSet

DataSet for the CandleStickChart.

Nested Class Summary

Nested classes/interfaces inherited from class com.github.mikephil.charting.data.DataSet

DataSet.Rounding

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mDecreasingColor color for open > close
protected android.graphics.Paint.Style	mDecreasingPaintStyle paint style when open > close descreasing candlesticks are traditionally filled
protected int	mIncreasingColor color for open < close
protected android.graphics.Paint.Style	mIncreasingPaintStyle paint style when open < close increasing candlesticks are traditionally hollow
protected int	mNeutralColor color for open == close
protected int	mShadowColor shadow line color, set -1 for backward compatibility and uses default color

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

mDrawHorizontalHighlightIndicator, mDrawVerticalHighlightIndicator, mHighlightDashPathEffect, mHighlightLineWidth

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

mHighLightColor

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

mEntries, mXMax, mXMin, mYMax, mYMin

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
CandleDataSet(java.util.List<CandleEntry> yVals, java.lang.String label)

Method Summary

Modifier and Type	Method and Description
protected void	calcMinMax(CandleEntry e) Updates the min and max x and y value of this DataSet based on the given Entry.
protected void	calcMinMaxY(CandleEntry e)
DataSet<CandleEntry>	copy() Provides an exact copy of the DataSet this method is used on.
protected void	copy(CandleDataSet candleDataSet)
float	getBarSpace() Returns the space that is left out on the left and right side of each candle.
int	getDecreasingColor() Returns the decreasing color (for open > close).
android.graphics.Paint.Style	getDecreasingPaintStyle() Returns paint style when open > close
int	getIncreasingColor() Returns the increasing color (for open < close).
android.graphics.Paint.Style	getIncreasingPaintStyle() Returns paint style when open < close
int	getNeutralColor() Returns the neutral color (for open == close)
int	getShadowColor() Returns shadow color for all entries
boolean	getShadowColorSameAsCandle() Is the shadow color same as the candle color?
float	getShadowWidth() Returns the width of the candle-shadow-line in pixels.
boolean	getShowCandleBar() Returns whether the candle bars should show? When false, only "ticks" will show - default: true
void	setBarSpace(float space) Sets the space that is left out on the left and right side of each candle, default 0.1f (10%), max 0.45f, min 0f
void	setDecreasingColor(int color) Sets the one and ONLY color that should be used for this DataSet when open > close.
void	setDecreasingPaintStyle(android.graphics.Paint.Style decreasingPaintStyle) Sets paint style when open > close
void	setIncreasingColor(int color) Sets the one and ONLY color that should be used for this DataSet when open <= close.
void	setIncreasingPaintStyle(android.graphics.Paint.Style paintStyle) Sets paint style when open < close
void	setNeutralColor(int color) Sets the one and ONLY color that should be used for this DataSet when open == close.
void	setShadowColor(int shadowColor) Sets shadow color for all entries
void	setShadowColorSameAsCandle(boolean shadowColorSameAsCandle) Sets shadow color to be the same color as the candle color
void	setShadowWidth(float width) Sets the width of the candle-shadow-line in pixels.
void	setShowCandleBar(boolean showCandleBar) Sets whether the candle bars should show?

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

copy, disableDashedHighlightLine, enableDashedHighlightLine, getDashPathEffectHighlight, getHighlightLineWidth, isDashedHighlightLineEnabled, isHorizontalHighlightIndicatorEnabled, isVerticalHighlightIndicatorEnabled, setDrawHighlightIndicators, setDrawHorizontalHighlightIndicator, setDrawVerticalHighlightIndicator, setHighlightLineWidth

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

copy, getHighLightColor, setHighLightColor

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

addEntry, addEntryOrdered, calcMinMax, calcMinMaxX, calcMinMaxY, clear, copy, getEntries, getEntriesForXValue, getEntryCount, getEntryForIndex, getEntryForXValue, getEntryForXValue, getEntryIndex, getEntryIndex, getValues, getXMax, getXMin, getYMax, getYMin, removeEntry, setEntries, setValues, toSimpleString, 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

Methods inherited from interface com.github.mikephil.charting.interfaces.datasets.ILineScatterCandleRadarDataSet

getDashPathEffectHighlight, getHighlightLineWidth, isHorizontalHighlightIndicatorEnabled, isVerticalHighlightIndicatorEnabled

Methods inherited from interface com.github.mikephil.charting.interfaces.datasets.IBarLineScatterCandleBubbleDataSet

getHighLightColor

Methods inherited from interface com.github.mikephil.charting.interfaces.datasets.IDataSet

addEntry, addEntryOrdered, calcMinMax, calcMinMaxY, clear, contains, getAxisDependency, getColor, getColor, getColors, getEntriesForXValue, getEntryCount, getEntryForIndex, getEntryForXValue, getEntryForXValue, getEntryIndex, getEntryIndex, getForm, getFormLineDashEffect, getFormLineWidth, getFormSize, getGradientColor, getGradientColor, getGradientColors, getIconsOffset, getIndexInEntries, getLabel, getValueFormatter, getValueTextColor, getValueTextColor, getValueTextSize, getValueTypeface, getXMax, getXMin, getYMax, getYMin, isDrawIconsEnabled, isDrawValuesEnabled, isHighlightEnabled, isVisible, needsFormatter, removeEntry, removeEntry, removeEntryByXValue, removeFirst, removeLast, setAxisDependency, setDrawIcons, setDrawValues, setHighlightEnabled, setIconsOffset, setLabel, setValueFormatter, setValueTextColor, setValueTextColors, setValueTextSize, setValueTypeface, setVisible

Field Detail

mIncreasingPaintStyle

protected android.graphics.Paint.Style mIncreasingPaintStyle

paint style when open < close increasing candlesticks are traditionally hollow

mDecreasingPaintStyle

protected android.graphics.Paint.Style mDecreasingPaintStyle

paint style when open > close descreasing candlesticks are traditionally filled

mNeutralColor

protected int mNeutralColor

color for open == close

mIncreasingColor

protected int mIncreasingColor

color for open < close

mDecreasingColor

protected int mDecreasingColor

color for open > close

mShadowColor

protected int mShadowColor

shadow line color, set -1 for backward compatibility and uses default color

Constructor Detail

CandleDataSet

public CandleDataSet(java.util.List<CandleEntry> yVals,
                     java.lang.String label)

Method Detail

copy

public DataSet<CandleEntry> copy()

Description copied from class: DataSet

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

Specified by:

copy in class DataSet<CandleEntry>

Returns:

copy

protected void copy(CandleDataSet candleDataSet)

calcMinMax

protected void calcMinMax(CandleEntry e)

Description copied from class: DataSet

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

Overrides:

calcMinMax in class DataSet<CandleEntry>

calcMinMaxY

protected void calcMinMaxY(CandleEntry e)

Overrides:

calcMinMaxY in class DataSet<CandleEntry>

setBarSpace

public void setBarSpace(float space)

Sets the space that is left out on the left and right side of each candle, default 0.1f (10%), max 0.45f, min 0f

Parameters:

space -

getBarSpace

public float getBarSpace()

Description copied from interface: ICandleDataSet

Returns the space that is left out on the left and right side of each candle.

Specified by:

getBarSpace in interface ICandleDataSet

Returns:

setShadowWidth

public void setShadowWidth(float width)

Sets the width of the candle-shadow-line in pixels. Default 3f.

Parameters:

width -

getShadowWidth

public float getShadowWidth()

Description copied from interface: ICandleDataSet

Returns the width of the candle-shadow-line in pixels.

Specified by:

getShadowWidth in interface ICandleDataSet

Returns:

setShowCandleBar

public void setShowCandleBar(boolean showCandleBar)

Sets whether the candle bars should show?

Parameters:

showCandleBar -

getShowCandleBar

public boolean getShowCandleBar()

Description copied from interface: ICandleDataSet

Returns whether the candle bars should show? When false, only "ticks" will show - default: true

Specified by:

getShowCandleBar in interface ICandleDataSet

Returns:

setNeutralColor

public void setNeutralColor(int color)

Sets the one and ONLY color that should be used for this DataSet when open == close.

Parameters:

color -

getNeutralColor

public int getNeutralColor()

Description copied from interface: ICandleDataSet

Returns the neutral color (for open == close)

Specified by:

getNeutralColor in interface ICandleDataSet

Returns:

setIncreasingColor

public void setIncreasingColor(int color)

Sets the one and ONLY color that should be used for this DataSet when open <= close.

Parameters:

color -

getIncreasingColor

public int getIncreasingColor()

Description copied from interface: ICandleDataSet

Returns the increasing color (for open < close).

Specified by:

getIncreasingColor in interface ICandleDataSet

Returns:

setDecreasingColor

public void setDecreasingColor(int color)

Sets the one and ONLY color that should be used for this DataSet when open > close.

Parameters:

color -

getDecreasingColor

public int getDecreasingColor()

Description copied from interface: ICandleDataSet

Returns the decreasing color (for open > close).

Specified by:

getDecreasingColor in interface ICandleDataSet

Returns:

getIncreasingPaintStyle

public android.graphics.Paint.Style getIncreasingPaintStyle()

Description copied from interface: ICandleDataSet

Returns paint style when open < close

Specified by:

getIncreasingPaintStyle in interface ICandleDataSet

Returns:

setIncreasingPaintStyle

public void setIncreasingPaintStyle(android.graphics.Paint.Style paintStyle)

Sets paint style when open < close

Parameters:

paintStyle -

getDecreasingPaintStyle

public android.graphics.Paint.Style getDecreasingPaintStyle()

Description copied from interface: ICandleDataSet

Returns paint style when open > close

Specified by:

getDecreasingPaintStyle in interface ICandleDataSet

Returns:

setDecreasingPaintStyle

public void setDecreasingPaintStyle(android.graphics.Paint.Style decreasingPaintStyle)

Sets paint style when open > close

Parameters:

decreasingPaintStyle -

getShadowColor

public int getShadowColor()

Description copied from interface: ICandleDataSet

Returns shadow color for all entries

Specified by:

getShadowColor in interface ICandleDataSet

Returns:

setShadowColor

public void setShadowColor(int shadowColor)

Sets shadow color for all entries

Parameters:

shadowColor -

getShadowColorSameAsCandle

public boolean getShadowColorSameAsCandle()

Description copied from interface: ICandleDataSet

Is the shadow color same as the candle color?

Specified by:

getShadowColorSameAsCandle in interface ICandleDataSet

Returns:

setShadowColorSameAsCandle

public void setShadowColorSameAsCandle(boolean shadowColorSameAsCandle)

Sets shadow color to be the same color as the candle color

Parameters:

shadowColorSameAsCandle -