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

CartesianChart

open class CartesianChart(layers: CartesianLayer<*>, startAxis: Axis<Axis.Position.Vertical.Start>? = null, topAxis: Axis<Axis.Position.Horizontal.Top>? = null, endAxis: Axis<Axis.Position.Vertical.End>? = null, bottomAxis: Axis<Axis.Position.Horizontal.Bottom>? = null, var marker: CartesianMarker? = null, var markerVisibilityListener: CartesianMarkerVisibilityListener? = null, var layerPadding: CartesianLayerPadding = CartesianLayerPadding(), var legend: Legend<CartesianMeasuringContext, CartesianDrawingContext>? = null, var fadingEdges: FadingEdges? = null, var decorations: List<Decoration> = emptyList(), var persistentMarkers: CartesianChart.PersistentMarkerScope.(ExtraStore) -> Unit? = null, var getXStep: (CartesianChartModel) -> Double = { it.getXDeltaGcd() }) : CartesianLayerInsetter<CartesianChartModel>

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

Parameters

startAxis

the start Axis.

topAxis

the top Axis.

endAxis

the end Axis.

bottomAxis

the bottom Axis.

Constructors

CartesianChart

constructor(vararg layers: CartesianLayer<*>, startAxis: Axis<Axis.Position.Vertical.Start>? = null, topAxis: Axis<Axis.Position.Horizontal.Top>? = null, endAxis: Axis<Axis.Position.Vertical.End>? = null, bottomAxis: Axis<Axis.Position.Horizontal.Bottom>? = null, marker: CartesianMarker? = null, markerVisibilityListener: CartesianMarkerVisibilityListener? = null, layerPadding: CartesianLayerPadding = CartesianLayerPadding(), legend: Legend<CartesianMeasuringContext, CartesianDrawingContext>? = null, fadingEdges: FadingEdges? = null, decorations: List<Decoration> = emptyList(), persistentMarkers: CartesianChart.PersistentMarkerScope.(ExtraStore) -> Unit? = null, getXStep: (CartesianChartModel) -> Double = { it.getXDeltaGcd() })

Types

PersistentMarkerScope

fun interface PersistentMarkerScope

Facilitates adding persistent CartesianMarkers to CartesianCharts.

Properties

bottomAxis

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

The bottom Axis.

decorations

var decorations: List<Decoration>

the Decorations.

endAxis

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

The end Axis.

fadingEdges

var fadingEdges: FadingEdges?

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

getXStep

var getXStep: (CartesianChartModel) -> Double

defines the x step (the difference between neighboring major x values).

layerPadding

var layerPadding: CartesianLayerPadding

stores the CartesianLayer padding values.

layers

val layers: List<CartesianLayer<*>>

The CartesianLayers of which this CartesianChart is composed.

legend

var legend: Legend<CartesianMeasuringContext, CartesianDrawingContext>?

the legend.

marker

var marker: CartesianMarker?

appears when the CartesianChart is tapped.

markerTargets

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

Links x values to CartesianMarker.Targets.

markerVisibilityListener

var markerVisibilityListener: CartesianMarkerVisibilityListener?

allows for listening to marker visibility changes.

persistentMarkers

var persistentMarkers: CartesianChart.PersistentMarkerScope.(ExtraStore) -> Unit?

adds persistent CartesianMarkers.

startAxis

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

The start Axis.

topAxis

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

The top Axis.

Functions

draw

fun draw(context: CartesianDrawingContext, pointerPosition: Point?)

Draws the CartesianChart.

prepare

fun prepare(context: CartesianMeasuringContext, horizontalDimensions: MutableHorizontalDimensions, canvasBounds: RectF)

Prepares the CartesianChart for drawing.

prepareForTransformation

fun prepareForTransformation(model: CartesianChartModel?, extraStore: MutableExtraStore, ranges: CartesianChartRanges)

Prepares the CartesianLayers for a difference animation.

transform

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

Carries out the pending difference animation.

updateHorizontalInsets

open override fun updateHorizontalInsets(context: CartesianMeasuringContext, freeHeight: Float, model: CartesianChartModel, insets: HorizontalInsets)

Ensures that there are sufficient horizontal insets. freeHeight is the height of the CartesianLayer area.

updateInsets

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

Ensures that there are sufficient insets.

updateRanges

fun updateRanges(ranges: MutableCartesianChartRanges, model: CartesianChartModel)

Updates ranges in accordance with model.