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

CandlestickCartesianLayer

@Stable
open class CandlestickCartesianLayer : BaseCartesianLayer<CandlestickCartesianLayerModel>

Draws the content of candlestick charts.

Constructors

Link copied to clipboard
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())

Creates a CandlestickCartesianLayer.

Types

Link copied to clipboard
data class Candle(val body: LineComponent, val topWick: LineComponent = body.asWick(), val bottomWick: LineComponent = topWick)

Defines a candle style.

Link copied to clipboard

Properties

Link copied to clipboard
open override val markerTargets: Map<Double, List<CartesianMarker.Target>>

Links x values to CartesianMarker.Targets.

Functions

Link copied to clipboard
fun copy(candles: CandlestickCartesianLayer.CandleProvider = this.candles, minCandleBodyHeightDp: Float = this.minCandleBodyHeightDp, candleSpacingDp: Float = this.candleSpacingDp, scaleCandleWicks: Boolean = this.scaleCandleWicks, rangeProvider: CartesianLayerRangeProvider = this.rangeProvider, verticalAxisPosition: Axis.Position.Vertical? = this.verticalAxisPosition, drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<CandlestickCartesianLayerDrawingModel.CandleInfo, CandlestickCartesianLayerDrawingModel> = this.drawingModelInterpolator): CandlestickCartesianLayer

Creates a new CandlestickCartesianLayer based on this one.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun prepareForTransformation(model: CandlestickCartesianLayerModel?, ranges: CartesianChartRanges, extraStore: MutableExtraStore)

Prepares the CartesianLayer for a difference animation.

Link copied to clipboard
open suspend override fun transform(extraStore: MutableExtraStore, fraction: Float)

Carries out the pending difference animation.

Link copied to clipboard
open override fun updateHorizontalDimensions(context: CartesianMeasuringContext, horizontalDimensions: MutableHorizontalDimensions, model: CandlestickCartesianLayerModel)

Updates horizontalDimensions to match this CartesianLayer’s dimensions.

Link copied to clipboard
open override fun updateRanges(ranges: MutableCartesianChartRanges, model: CandlestickCartesianLayerModel)

Updates ranges in accordance with model.