core/com.patrykandpatrick.vico.core.cartesian.data/CandlestickCartesianLayerDrawingModel/CandleInfo

CandleInfo

class CandleInfo(val bodyBottomY: Float, val bodyTopY: Float, val bottomWickY: Float, val topWickY: Float) : CartesianLayerDrawingModel.DrawingInfo

Houses positional information for a CandlestickCartesianLayer’s candle. Each position is stored as a distance from the bottom of the CandlestickCartesianLayer. The distances are expressed as fractions of the CandlestickCartesianLayer’s height.

Constructors

CandleInfo

constructor(bodyBottomY: Float, bodyTopY: Float, bottomWickY: Float, topWickY: Float)

Properties

bodyBottomY

val bodyBottomY: Float

the position of the body’s bottom edge.

bodyTopY

val bodyTopY: Float

the position of the body’s top edge.

bottomWickY

val bottomWickY: Float

the position of the bottom wick’s bottom edge.

topWickY

val topWickY: Float

the position of the top wick’s top edge.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

transform

open override fun transform(from: CartesianLayerDrawingModel.DrawingInfo?, fraction: Float): CartesianLayerDrawingModel.DrawingInfo

Returns an intermediate DrawingInfo implementation between this one and from. fraction is the balance between from and this DrawingInfo implementation, with 0 corresponding to from, and 1 corresponding to this DrawingInfo implementation. The returned object should be an instance of the DrawingInfo implementation to which this function belongs.