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

LineCartesianLayer

open class LineCartesianLayer : 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.Entry, LineCartesianLayerDrawingModel> = CartesianLayerDrawingModelInterpolator.default())

Creates a LineCartesianLayer.

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 stroke: LineCartesianLayer.LineStroke = LineStroke.Continuous(), areaFill: LineCartesianLayer.AreaFill? = null, val pointProvider: LineCartesianLayer.PointProvider? = null, val pointConnector: LineCartesianLayer.PointConnector = PointConnector.Sharp, val dataLabel: TextComponent? = null, val dataLabelPosition: Position.Vertical = Position.Vertical.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.

sealed interface LineStroke

Defines the style of a LineCartesianLayer line’s stroke.

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

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

Links x values to CartesianMarker.Targets.

Functions

fun copy(lineProvider: LineCartesianLayer.LineProvider = this.lineProvider, pointSpacingDp: Float = this.pointSpacingDp, rangeProvider: CartesianLayerRangeProvider = this.rangeProvider, verticalAxisPosition: Axis.Position.Vertical? = this.verticalAxisPosition, drawingModelInterpolator: CartesianLayerDrawingModelInterpolator<LineCartesianLayerDrawingModel.Entry, LineCartesianLayerDrawingModel> = this.drawingModelInterpolator): LineCartesianLayer

Creates a new LineCartesianLayer based on this one.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

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.

updateChartRanges

open override fun updateChartRanges(chartRanges: MutableCartesianChartRanges, model: LineCartesianLayerModel)

Updates chartRanges in accordance with model.

updateDimensions

open override fun updateDimensions(context: CartesianMeasuringContext, dimensions: MutableCartesianLayerDimensions, model: LineCartesianLayerModel)

Updates dimensions to match this CartesianLayer’s dimensions.

updateLayerMargins

open override fun updateLayerMargins(context: CartesianMeasuringContext, layerMargins: CartesianLayerMargins, layerDimensions: CartesianLayerDimensions, model: LineCartesianLayerModel)

Ensures that there are sufficient CartesianLayer-area margins.