LineCartesianLayer

Use LineCartesianLayer to create line charts. Each line is associated with a LineCartesianLayer.Line instance. These are provided by LineCartesianLayer.LineProvider. A base implementation of this interface can be instantiated via LineCartesianLayer.LineProvider.series. You can customize line fills, backgrounds, shapes, and other properties. You can also add data labels and points.

Line strokes are customized via LineCartesianLayer.LineStroke, which has two implementations:

• LineCartesianLayer.LineStroke.Continuous

• LineCartesianLayer.LineStroke.Dashed

Line fills are customized via LineCartesianLayer.LineFill, which has two factory functions:

• LineCartesianLayer.LineFill.single

• LineCartesianLayer.LineFill.double

Area fills, which are optional, are customized via LineCartesianLayer.AreaFill. This has similar factory functions to LineCartesianLayer.LineFill:

• LineCartesianLayer.AreaFill.single

• LineCartesianLayer.AreaFill.double

These cover most use cases. You can use both solid colors and ShaderProvider instances, and you can apply split styling—enabling you to create a line that’s green for positive values and red for negative values, for instance. You can, however, also create your own LineCartesianLayer.LineFill and LineCartesianLayer.AreaFill implementations.

To add points, use LineCartesianLayer.PointProvider. LineCartesianLayer.PointProvider.single instantiates a base implementation that adds a point for each entry and uses a shared point style. Once again, custom implementations can be created. A common use case for this is styling points individually based on their y-values.

To create a LineCartesianLayer instance, use the XML attributes:

<style name="ChartStyle">
    <item name="layers">line</item>
    <!-- ... -->
</style>

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

Alternatively, instantiate LineCartesianLayer via the constructor:

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

Transaction.lineSeries

Line layers use LineCartesianLayerModel instances. When using CartesianChartModelProducer, add them via lineSeries:

cartesianChartModelProducer.runTransaction {
    lineSeries {
        series(1, 8, 3, 7)
        series(y = listOf(6, 1, 9, 3))
        series(x = listOf(1, 2, 3, 4), y = listOf(2, 5, 3, 4))
    }
    // ...
}

Each series invocation adds a series to the LineCartesianLayerModel instance. Above, three series are added. series has three overloads (each of which accepts all Number subtypes):

• a vararg overload that takes y-values and uses their indices as the x-values

• an overload that takes a collection of y-values and uses their indices as the x-values

• an overload that takes a collection of x-values and a collection of y-values of the same size

Manual LineCartesianLayerModel creation

When creating a CartesianChartModel instance directly, you can add a line-layer model by using build. This function gives you access to the same DSL that lineSeries does.

CartesianChartModel(
    LineCartesianLayerModel.build {
        series(1, 8, 3, 7)
        series(y = listOf(6, 1, 9, 3))
        series(x = listOf(1, 2, 3, 4), y = listOf(2, 5, 3, 4))
    },
    // ...
)

Sample charts

• “Basic line chart”

• “Basic combo chart”

• “AI test scores”

• “Electric-car sales (Norway)”