com.github.mikephil.charting.data

Class CandleEntry

java.lang.Object

com.github.mikephil.charting.data.BaseEntry

com.github.mikephil.charting.data.Entry

com.github.mikephil.charting.data.CandleEntry

All Implemented Interfaces:

android.os.Parcelable

public class CandleEntry
extends Entry

Subclass of Entry that holds all values for one entry in a CandleStickChart.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

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

CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
CandleEntry(float x, float shadowH, float shadowL, float open, float close) Constructor.
CandleEntry(float x, float shadowH, float shadowL, float open, float close, android.graphics.drawable.Drawable icon) Constructor.
CandleEntry(float x, float shadowH, float shadowL, float open, float close, android.graphics.drawable.Drawable icon, java.lang.Object data) Constructor.
CandleEntry(float x, float shadowH, float shadowL, float open, float close, java.lang.Object data) Constructor.

Method Summary

Modifier and Type	Method and Description
CandleEntry	copy() returns an exact copy of the entry
float	getBodyRange() Returns the body size (difference between open and close).
float	getClose() Returns the bodys close value.
float	getHigh() Returns the upper shadows highest value.
float	getLow() Returns the lower shadows lowest value.
float	getOpen() Returns the bodys open value.
float	getShadowRange() Returns the overall range (difference) between shadow-high and shadow-low.
float	getY() Returns the center value of the candle.
void	setClose(float mClose)
void	setHigh(float mShadowHigh)
void	setLow(float mShadowLow)
void	setOpen(float mOpen)

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

describeContents, equalTo, getX, setX, toString, writeToParcel

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

getData, getIcon, setData, setIcon, setY

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CandleEntry

public CandleEntry(float x,
                   float shadowH,
                   float shadowL,
                   float open,
                   float close)

Constructor.

Parameters:

x - The value on the x-axis

shadowH - The (shadow) high value

shadowL - The (shadow) low value

open - The open value

close - The close value

CandleEntry

public CandleEntry(float x,
                   float shadowH,
                   float shadowL,
                   float open,
                   float close,
                   java.lang.Object data)

Constructor.

Parameters:

x - The value on the x-axis

shadowH - The (shadow) high value

shadowL - The (shadow) low value

open -

close -

data - Spot for additional data this Entry represents

CandleEntry

public CandleEntry(float x,
                   float shadowH,
                   float shadowL,
                   float open,
                   float close,
                   android.graphics.drawable.Drawable icon)

Constructor.

Parameters:

x - The value on the x-axis

shadowH - The (shadow) high value

shadowL - The (shadow) low value

open -

close -

icon - Icon image

CandleEntry

public CandleEntry(float x,
                   float shadowH,
                   float shadowL,
                   float open,
                   float close,
                   android.graphics.drawable.Drawable icon,
                   java.lang.Object data)

Constructor.

Parameters:

x - The value on the x-axis

shadowH - The (shadow) high value

shadowL - The (shadow) low value

open -

close -

icon - Icon image

data - Spot for additional data this Entry represents

Method Detail

getShadowRange

public float getShadowRange()

Returns the overall range (difference) between shadow-high and shadow-low.

Returns:

getBodyRange

public float getBodyRange()

Returns the body size (difference between open and close).

Returns:

getY

public float getY()

Returns the center value of the candle. (Middle value between high and low)

Overrides:

getY in class BaseEntry

Returns:

copy

public CandleEntry copy()

Description copied from class: Entry

returns an exact copy of the entry

Overrides:

copy in class Entry

Returns:

getHigh

public float getHigh()

Returns the upper shadows highest value.

Returns:

setHigh

public void setHigh(float mShadowHigh)

getLow

public float getLow()

Returns the lower shadows lowest value.

Returns:

setLow

public void setLow(float mShadowLow)

getClose

public float getClose()

Returns the bodys close value.

Returns:

setClose

public void setClose(float mClose)

getOpen

public float getOpen()

Returns the bodys open value.

Returns:

setOpen

public void setOpen(float mOpen)