core/com.patrykandpatrick.vico.core.chart

Package-level declarations

Types

BaseChart

abstract class BaseChart<in Model : ChartEntryModel> : Chart<Model> , BoundsAware

A base implementation of Chart.

Chart

interface Chart<in Model> : BoundsAware, ChartInsetter

Defines the minimal set of properties and functions required by other parts of the library to draw a chart.

DefaultPointConnector

class DefaultPointConnector(cubicStrength: Float = DefaultDimens.CUBIC_STRENGTH) : LineChart.LineSpec.PointConnector

The default implementation of LineChart.LineSpec.PointConnector. This uses cubic bezier curves.

Functions

addDecorations

fun <Model> Chart<Model>.addDecorations(decorations: List<Decoration>): Boolean

Adds each Decoration from decorations to this Chart.

copy

fun LineChart.LineSpec.copy(lineColor: Int = this.lineColor, lineThicknessDp: Float = this.lineThicknessDp, lineBackgroundShader: DynamicShader? = this.lineBackgroundShader, lineCap: Paint.Cap = this.lineCap, point: Component? = this.point, pointSizeDp: Float = this.pointSizeDp, dataLabel: TextComponent? = this.dataLabel, dataLabelVerticalPosition: VerticalPosition = this.dataLabelVerticalPosition, dataLabelValueFormatter: ValueFormatter = this.dataLabelValueFormatter, dataLabelRotationDegrees: Float = this.dataLabelRotationDegrees, pointConnector: LineChart.LineSpec.PointConnector = this.pointConnector): LineChart.LineSpec

Creates a new LineChart.LineSpec based on this one, updating select properties.

forEachIn

inline fun List<ChartEntry>.~~forEachIn~~(range: ClosedFloatingPointRange<Float>, action: (ChartEntry) -> Unit)

For each ChartEntry in the list such that ChartEntry.x belongs to the provided range, calls the action function block with the ChartEntry as the block’s argument.

forEachInAbsolutelyIndexed

inline fun List<ChartEntry>.~~forEachInAbsolutelyIndexed~~(range: ClosedFloatingPointRange<Float>, action: (Int, ChartEntry) -> Unit)

For each ChartEntry in the list such that ChartEntry.x belongs to the provided range, calls the action function block with the ChartEntry and its index in the list as the block’s arguments.

inline fun List<ChartEntry>.~~forEachInAbsolutelyIndexed~~(range: ClosedFloatingPointRange<Float>, action: (Int, ChartEntry, ChartEntry?) -> Unit)

For each ChartEntry in the list such that ChartEntry.x belongs to the provided range, calls the action function block with the ChartEntry, its index in the list, and the next ChartEntry in the filtered list as the block’s arguments.

forEachInRelativelyIndexed

inline fun List<ChartEntry>.~~forEachInRelativelyIndexed~~(range: ClosedFloatingPointRange<Float>, action: (Int, ChartEntry) -> Unit)

For each ChartEntry in the list such that ChartEntry.x belongs to the provided range, calls the action function block with the ChartEntry and its index in the filtered list as the block’s arguments.

inline fun List<ChartEntry>.~~forEachInRelativelyIndexed~~(range: ClosedFloatingPointRange<Float>, action: (Int, ChartEntry, ChartEntry?) -> Unit)

For each ChartEntry in the list such that ChartEntry.x belongs to the provided range, calls the action function block with the ChartEntry, its index in the filtered list, and the next ChartEntry in the filtered list as the block’s arguments.