compose/com.patrykandpatrick.vico.compose.cartesian

Package-level declarations

Types

Link copied to clipboard
class VicoScrollState

Houses information on a CartesianChart’s scroll value. Allows for scroll customization and programmatic scrolling.

Link copied to clipboard
class VicoZoomState

Houses information on a CartesianChart’s zoom factor. Allows for zoom customization.

Functions

Link copied to clipboard
@Composable
fun CartesianChartHost(chart: CartesianChart, model: CartesianChartModel, modifier: Modifier = Modifier, scrollState: VicoScrollState = rememberVicoScrollState(), zoomState: VicoZoomState = rememberDefaultVicoZoomState(scrollState.scrollEnabled))

Displays a CartesianChart. This function accepts a CartesianChartModel. For dynamic data, use the function overload that accepts a CartesianChartModelProducer instance.

@Composable
fun CartesianChartHost(chart: CartesianChart, modelProducer: CartesianChartModelProducer, modifier: Modifier = Modifier, scrollState: VicoScrollState = rememberVicoScrollState(), zoomState: VicoZoomState = rememberDefaultVicoZoomState(scrollState.scrollEnabled), animationSpec: AnimationSpec<Float>? = defaultCartesianDiffAnimationSpec, runInitialAnimation: Boolean = true, placeholder: @Composable BoxScope.() -> Unit = {})

Displays a CartesianChart.

Link copied to clipboard
fun cartesianLayerPadding(scalableStart: Dp = 0.dp, scalableEnd: Dp = 0.dp, unscalableStart: Dp = 0.dp, unscalableEnd: Dp = 0.dp): CartesianLayerPadding

Creates a CartesianLayerPadding instance.

Link copied to clipboard
@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: 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() }): CartesianChart

Creates and remembers a CartesianChart.

Link copied to clipboard
@Composable
fun rememberFadingEdges(edgeWidth: Dp = FadingEdgesDefaults.edgeWidth, visibilityThreshold: Dp = FadingEdgesDefaults.visibilityThreshold, visibilityEasing: Easing = FadingEdgesDefaults.visibilityEasing): FadingEdges
@Composable
fun rememberFadingEdges(startEdgeWidth: Dp = FadingEdgesDefaults.edgeWidth, endEdgeWidth: Dp = FadingEdgesDefaults.edgeWidth, visibilityThreshold: Dp = FadingEdgesDefaults.visibilityThreshold, visibilityEasing: Easing = FadingEdgesDefaults.visibilityEasing): FadingEdges

Creates and remembers a FadingEdges instance.

Link copied to clipboard
@Composable
fun rememberVicoScrollState(scrollEnabled: Boolean = true, initialScroll: Scroll.Absolute = Scroll.Absolute.Start, autoScroll: Scroll = initialScroll, autoScrollCondition: AutoScrollCondition = AutoScrollCondition.Never, autoScrollAnimationSpec: AnimationSpec<Float> = spring()): VicoScrollState

Creates and remembers a VicoScrollState instance.

Link copied to clipboard
@Composable
fun rememberVicoZoomState(zoomEnabled: Boolean = true, initialZoom: Zoom = remember { Zoom.max(Zoom.static(), Zoom.Content) }, minZoom: Zoom = Zoom.Content, maxZoom: Zoom = remember { Zoom.max(Zoom.static(Defaults.MAX_ZOOM), Zoom.Content) }): VicoZoomState

Creates and remembers a VicoZoomState instance.