core/com.patrykandpatrick.vico.core.cartesian/CartesianChart

CartesianChart

open class CartesianChart(layers: List<CartesianLayer<*>>, var legend: Legend<CartesianMeasureContext, CartesianDrawContext>? = null, var fadingEdges: FadingEdges? = null) : BoundsAware, ChartInsetter

A chart based on a Cartesian coordinate plane, composed of CartesianLayers.

Constructors

constructor(vararg layers: CartesianLayer<*>, legend: Legend<CartesianMeasureContext, CartesianDrawContext>? = null, fadingEdges: FadingEdges? = null)

constructor(layers: List<CartesianLayer<*>>, legend: Legend<CartesianMeasureContext, CartesianDrawContext>? = null, fadingEdges: FadingEdges? = null)

Properties

var bottomAxis: Axis<AxisPosition.Horizontal.Bottom>?

The bottom axis.

open override val bounds: RectF

The bounds of the abstract component.

val chartInsetters: Collection<ChartInsetter>

The CartesianChart’s ChartInsetters (persistent CartesianMarkers).

var endAxis: Axis<AxisPosition.Vertical.End>?

The end axis.

var fadingEdges: FadingEdges?

applies a horizontal fade to the edges of the CartesianChart, provided that it’s scrollable.

val layers: List<CartesianLayer<*>>

The CartesianLayers of which this CartesianChart is composed.

var legend: Legend<CartesianMeasureContext, CartesianDrawContext>?

the legend.

val markerTargets: SortedMap<Float, List<CartesianMarker.Target>>

Links x values to CartesianMarker.Targets.

var startAxis: Axis<AxisPosition.Vertical.Start>?

The start axis.

var topAxis: Axis<AxisPosition.Horizontal.Top>?

The top axis.

Functions

fun addDecoration(decoration: Decoration)

Adds the provided Decoration.

addPersistentMarker

fun addPersistentMarker(x: Float, marker: CartesianMarker)

Adds the provided persistent CartesianMarker at x.

fun draw(context: CartesianDrawContext, model: CartesianChartModel)

Draws the CartesianChart.

getHorizontalInsets

open override fun getHorizontalInsets(context: CartesianMeasureContext, availableHeight: Float, outInsets: HorizontalInsets)

Called during the measurement phase, after getInsets. Only horizontal insets can be requested from this function. Unless the available height is of interest, getInsets can be used to set all insets. The final inset for a given edge of the associated CartesianChart is the largest of the insets requested for the edge.

open override fun getInsets(context: CartesianMeasureContext, outInsets: Insets, horizontalDimensions: HorizontalDimensions)

Called during the measurement phase, before getHorizontalInsets. Both horizontal and vertical insets can be requested from this function. The final inset for a given edge of the associated CartesianChart is the largest of the insets requested for the edge.

fun prepare(context: CartesianMeasureContext, model: CartesianChartModel, horizontalDimensions: MutableHorizontalDimensions, bounds: RectF, marker: CartesianMarker?)

Prepares the CartesianChart for drawing.

prepareForTransformation

fun prepareForTransformation(model: CartesianChartModel?, extraStore: MutableExtraStore, chartValues: ChartValues)

Prepares the CartesianLayers for a difference animation.

removeDecoration

fun removeDecoration(decoration: Decoration): Boolean

Removes the specified Decoration, provided that it’s present.

removePersistentMarker

fun removePersistentMarker(x: Float): Boolean

Removes the persistent CartesianMarker at x, provided that there is such a CartesianMarker.

open override fun setBounds(left: Number, top: Number, right: Number, bottom: Number)

Sets the coordinates of the bounds to the provided values.

open fun setBounds(bounds: RectF)

Sets the coordinates of the bounds to the provided bounds.

fun setDecorations(decorations: List<Decoration>)

Removes all Decorations and adds the provided ones.

setPersistentMarkers

fun setPersistentMarkers(markers: Map<Float, CartesianMarker>)

Removes all persistent CartesianMarkers and adds the provided ones.

suspend fun transform(extraStore: MutableExtraStore, fraction: Float)

Carries out the pending difference animation.

updateChartValues

fun updateChartValues(chartValues: MutableChartValues, model: CartesianChartModel, xStep: Float?)

Updates chartValues in accordance with model.