compose/com.patrykandpatrick.vico.compose.cartesian/rememberCartesianChart

rememberCartesianChart

@Composable
fun rememberCartesianChart(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: (ExtraStore) -> CartesianLayerPadding = { CartesianLayerPadding() }, legend: Legend<CartesianMeasuringContext, CartesianDrawingContext>? = null, fadingEdges: FadingEdges? = null, decorations: List<Decoration> = emptyList(), persistentMarkers: CartesianChart.PersistentMarkerScope.(ExtraStore) -> Unit? = null, getXStep: (CartesianChartModel, Double, Double) -> Double = { model, minX, _ -> getDefaultXStep(model, minX) }, markerController: CartesianMarkerController = CartesianMarkerController.rememberShowOnPress()): CartesianChart

Creates and remembers a CartesianChart.

Parameters

layers
startAxis

the start Axis.

topAxis

the top Axis.

endAxis

the end Axis.

bottomAxis

the bottom Axis.

marker

appears when the CartesianChart is tapped.

markerVisibilityListener

allows for listening to marker visibility changes.

layerPadding
legend

the legend.

fadingEdges

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

decorations
persistentMarkers

adds persistent CartesianMarkers.

getXStep

defines the x-step (the difference between neighboring major x-values). Receives the model and the final minimum and maximum x-values.

markerController

controls marker visibility.

See also

@Composable
fun rememberCartesianChart(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: (ExtraStore) -> CartesianLayerPadding = { CartesianLayerPadding() }, legend: Legend<CartesianMeasuringContext, CartesianDrawingContext>? = null, fadingEdges: FadingEdges? = null, decorations: List<Decoration> = emptyList(), persistentMarkers: CartesianChart.PersistentMarkerScope.(ExtraStore) -> Unit? = null, getXStep: (CartesianChartModel) -> Double, markerController: CartesianMarkerController = CartesianMarkerController.rememberShowOnPress()): CartesianChart

Deprecated

Use the overload whose `getXStep` lambda also receives the final minimum and maximum x-values.

Creates and remembers a CartesianChart.

Parameters

layers
startAxis

the start Axis.

topAxis

the top Axis.

endAxis

the end Axis.

bottomAxis

the bottom Axis.

marker

appears when the CartesianChart is tapped.

markerVisibilityListener

allows for listening to marker visibility changes.

layerPadding
legend

the legend.

fadingEdges

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

decorations
persistentMarkers

adds persistent CartesianMarkers.

getXStep

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

markerController

controls marker visibility.

See also

Generated by Dokka
© 2026 Copyright