VicoScrollState

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

Constructors

constructor(scrollEnabled: Boolean = true, initialScroll: Scroll.Absolute = Scroll.Absolute.Start, autoScroll: Scroll = initialScroll, autoScrollCondition: AutoScrollCondition = AutoScrollCondition.Never, autoScrollAnimationSpec: AnimationSpec<Float> = spring(), xSnapStep: Double? = null, snapAnimationSpec: AnimationSpec<Float> = spring())

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

The maximum scroll value (in pixels).

The current scroll value (in pixels).

suspend fun animateScroll(scroll: Scroll, animationSpec: AnimationSpec<Float> = spring())

Triggers an animated scroll.

suspend fun scroll(scroll: Scroll)

Triggers a scroll.