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

ChartScrollSpec

@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.

Constructors

Link copied to clipboard
constructor(isScrollEnabled: Boolean, initialScroll: InitialScroll, autoScrollCondition: AutoScrollCondition<Model>, autoScrollAnimationSpec: AnimationSpec<Float>)

Properties

Link copied to clipboard
val autoScrollAnimationSpec: AnimationSpec<Float>

the AnimationSpec to use for automatic scrolling.

Link copied to clipboard
val autoScrollCondition: AutoScrollCondition<Model>

defines when an automatic scroll should be performed.

Link copied to clipboard
val initialScroll: InitialScroll

represents the chart’s initial scroll position.

Link copied to clipboard
val isScrollEnabled: Boolean

whether horizontal scrolling is enabled.

Functions

Link copied to clipboard
suspend fun performAutoScroll(model: Model, oldModel: Model?, chartScrollState: ChartScrollState)

Performs an automatic scroll.