compose/com.patrykandpatrick.vico.compose.cartesian/VicoScrollState

VicoScrollState

class VicoScrollState

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

Constructors

VicoScrollState

constructor(scrollEnabled: Boolean, initialScroll: Scroll.Absolute, autoScroll: Scroll, autoScrollCondition: AutoScrollCondition, autoScrollAnimationSpec: AnimationSpec<Float>)

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

Properties

var maxValue: Float

The maximum scroll value (in pixels).

var value: Float

The current scroll value (in pixels).

Functions

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

Triggers an animated scroll.

suspend fun scroll(scroll: Scroll)

Triggers a scroll.