core/com.patrykandpatrick.vico.core.cartesian.layer/CandlestickCartesianLayer

CandlestickCartesianLayer

open class CandlestickCartesianLayer(var candles: CandlestickCartesianLayer.CandleProvider, var minCandleBodyHeightDp: Float = Defaults.MIN_CANDLE_BODY_HEIGHT_DP, var candleSpacingDp: Float = Defaults.CANDLE_SPACING_DP, var scaleCandleWicks: Boolean = false, var rangeProvider: CartesianLayerRangeProvider = CartesianLayerRangeProvider.auto(), var verticalAxisPosition: Axis.Position.Vertical? = null, var drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<CandlestickCartesianLayerDrawingModel.CandleInfo, CandlestickCartesianLayerDrawingModel> = CartesianLayerDrawingModelInterpolator.default()) : BaseCartesianLayer<CandlestickCartesianLayerModel>

Draws the content of candlestick charts.

Constructors

constructor(candles: CandlestickCartesianLayer.CandleProvider, minCandleBodyHeightDp: Float = Defaults.MIN_CANDLE_BODY_HEIGHT_DP, candleSpacingDp: Float = Defaults.CANDLE_SPACING_DP, scaleCandleWicks: Boolean = false, rangeProvider: CartesianLayerRangeProvider = CartesianLayerRangeProvider.auto(), verticalAxisPosition: Axis.Position.Vertical? = null, drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<CandlestickCartesianLayerDrawingModel.CandleInfo, CandlestickCartesianLayerDrawingModel> = CartesianLayerDrawingModelInterpolator.default())

Types

Candle

data class Candle(val body: LineComponent, val topWick: LineComponent = body.asWick(), val bottomWick: LineComponent = topWick)

Defines a candle style.

CandleProvider

interface CandleProvider

Provides Candles to CandlestickCartesianLayers.

Properties

candles

var candles: CandlestickCartesianLayer.CandleProvider

provides the Candles.

candleSpacingDp

var candleSpacingDp: Float

the spacing between neighboring candles.

drawingModelInterpolator

var drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<CandlestickCartesianLayerDrawingModel.CandleInfo, CandlestickCartesianLayerDrawingModel>

markerTargets

open override val markerTargets: Map<Double, List<CartesianMarker.Target>>

Links x values to CartesianMarker.Targets.

minCandleBodyHeightDp

var minCandleBodyHeightDp: Float

the minimum height of the candle bodies (in dp).

rangeProvider

var rangeProvider: CartesianLayerRangeProvider

defines the x and y ranges.

scaleCandleWicks

var scaleCandleWicks: Boolean

whether the candle wicks should be scaled based on the zoom factor.

verticalAxisPosition

var verticalAxisPosition: Axis.Position.Vertical?

the position of the VerticalAxis with which the CandlestickCartesianLayer should be associated. Use this for independent CartesianLayer scaling.

Functions

prepareForTransformation

open override fun prepareForTransformation(model: CandlestickCartesianLayerModel?, ranges: CartesianChartRanges, extraStore: MutableExtraStore)

Prepares the CartesianLayer for a difference animation.

transform

open suspend override fun transform(extraStore: MutableExtraStore, fraction: Float)

Carries out the pending difference animation.

updateHorizontalDimensions

open override fun updateHorizontalDimensions(context: CartesianMeasuringContext, horizontalDimensions: MutableHorizontalDimensions, model: CandlestickCartesianLayerModel)

Updates horizontalDimensions to match this CartesianLayer’s dimensions.

updateRanges

open override fun updateRanges(ranges: MutableCartesianChartRanges, model: CandlestickCartesianLayerModel)

Updates ranges in accordance with model.