compose/com.patrykandpatrick.vico.compose.chart.scroll

Package-level declarations

Types

Link copied to clipboard
@Stable
class ChartScrollSpec<in Model : ChartEntryModel>(val isScrollEnabled: Boolean, val initialScroll: InitialScroll, val autoScrollCondition: AutoScrollCondition<Model>, val autoScrollAnimationSpec: AnimationSpec<Float>)

Houses scrolling-related settings for charts.

Link copied to clipboard
class ChartScrollState : ScrollableState, ScrollListenerHost

Houses information on a Chart’s scroll state. Allows for programmatic scrolling.

Functions

Link copied to clipboard
@Composable
fun <Model : ChartEntryModel> rememberChartScrollSpec(isScrollEnabled: Boolean = true, initialScroll: InitialScroll = InitialScroll.Start, autoScrollCondition: AutoScrollCondition<Model> = AutoScrollCondition.Never, autoScrollAnimationSpec: AnimationSpec<Float> = spring()): ChartScrollSpec<Model>

Creates and remembers an instance of ChartScrollSpec.

Link copied to clipboard
@Composable
fun rememberChartScrollState(): ChartScrollState

Creates and remembers a ChartScrollState instance.