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

LineCartesianLayer

open class LineCartesianLayer(var lineProvider: LineCartesianLayer.LineProvider, var pointSpacingDp: Float = Defaults.POINT_SPACING, var rangeProvider: CartesianLayerRangeProvider = CartesianLayerRangeProvider.auto(), var verticalAxisPosition: Axis.Position.Vertical? = null, var drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<LineCartesianLayerDrawingModel.PointInfo, LineCartesianLayerDrawingModel> = CartesianLayerDrawingModelInterpolator.default()) : BaseCartesianLayer<LineCartesianLayerModel>

Draws the content of line charts.

Constructors

LineCartesianLayer

constructor(lineProvider: LineCartesianLayer.LineProvider, pointSpacingDp: Float = Defaults.POINT_SPACING, rangeProvider: CartesianLayerRangeProvider = CartesianLayerRangeProvider.auto(), verticalAxisPosition: Axis.Position.Vertical? = null, drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<LineCartesianLayerDrawingModel.PointInfo, LineCartesianLayerDrawingModel> = CartesianLayerDrawingModelInterpolator.default())

Types

interface AreaFill

Draws a LineCartesianLayer line’s area fill.

object Companion

Provides access to Line and Point factory functions.

open class Line(fill: LineCartesianLayer.LineFill, val thicknessDp: Float = Defaults.LINE_SPEC_THICKNESS_DP, areaFill: LineCartesianLayer.AreaFill? = fill.getDefaultAreaFill(), cap: Paint.Cap = Paint.Cap.ROUND, val pointProvider: LineCartesianLayer.PointProvider? = null, val pointConnector: LineCartesianLayer.PointConnector = PointConnector.cubic(), val dataLabel: TextComponent? = null, val dataLabelVerticalPosition: VerticalPosition = VerticalPosition.Top, val dataLabelValueFormatter: CartesianValueFormatter = CartesianValueFormatter.decimal(), val dataLabelRotationDegrees: Float = 0.0f)

Defines the appearance of a line in a line chart.

interface LineFill

Draws a LineCartesianLayer line’s fill.

fun interface LineProvider

Provides Lines to LineCartesianLayers.

data class Point(component: Component, val sizeDp: Float = Defaults.POINT_SIZE)

Defines a point style.

fun interface PointConnector

Connects a LineCartesianLayer line’s points, thus defining its shape.

interface PointProvider

Provides Points to LineCartesianLayers.

Properties

drawingModelInterpolator

var drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<LineCartesianLayerDrawingModel.PointInfo, LineCartesianLayerDrawingModel>

interpolates the LineCartesianLayerDrawingModels.

var lineProvider: LineCartesianLayer.LineProvider

provides the Lines.

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

Links x values to CartesianMarker.Targets.

var pointSpacingDp: Float

the point spacing (in dp).

var rangeProvider: CartesianLayerRangeProvider

overrides the x and y ranges.

verticalAxisPosition

var verticalAxisPosition: Axis.Position.Vertical?

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

Functions

prepareForTransformation

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

Prepares the CartesianLayer for a difference animation.

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: LineCartesianLayerModel)

Updates horizontalDimensions to match this CartesianLayer’s dimensions.

open override fun updateInsets(context: CartesianMeasuringContext, horizontalDimensions: HorizontalDimensions, model: LineCartesianLayerModel, insets: Insets)

Ensures that there are sufficient insets.

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

Updates ranges in accordance with model.