CandlestickCartesianLayer

Overview

Use CandlestickCartesianLayerarrow-up-right to create candlestick charts. Each candle’s style is defined by its corresponding Candlearrow-up-right. The Candles are provided by a CandleProviderarrow-up-right:

  • To style candles based on their absolute price changes (closing vs. opening), use absolutearrow-up-right. This is commonly used for filled candles.

  • To style candles based on both their absolute price changes (closing vs. opening) and their relative price changes (closing vs. previous closing), use absoluteRelativearrow-up-right. This is commonly used for hollow candles.

  • For custom behavior, implement CandleProvider.

At the CandlestickCartesianLayer level, you can set the minimum body height, change the candle spacing, and toggle wick scaling.

To create a CandlestickCartesianLayerarrow-up-right, use the XML attributes:

<style name="ChartStyle">
    <item name="layers">candlestick</item>
    <!-- ... -->
</style>
<com.patrykandpatrick.vico.views.cartesian.CartesianChartView
    app:chartStyle="@style/ChartStyle"
    <!-- ... --> />

Alternatively, use the CandlestickCartesianLayer constructor:

cartesianChartView.chart = CartesianChart(CandlestickCartesianLayer(/* ... */), /* ... */)

Transaction.candlestickSeries

CandlestickCartesianLayers use CandlestickCartesianLayerModelarrow-up-rights. When using a CartesianChartModelProducer, add CandlestickCartesianLayerModels via candlestickSeriesarrow-up-right:

candlestickSeries also has an overload with no x parameter, which uses the indices of the prices as the x-values:

Manual CandlestickCartesianLayerModel creation

When creating a CartesianChartModelarrow-up-right directly, you can add a CandlestickCartesianLayerModel by using buildarrow-up-right:

This function also has an overload with no x parameter:

Sample charts

Last updated