views/com.patrykandpatrick.vico.views.cartesian/ScrollHandler

ScrollHandler

class ScrollHandler(scrollEnabled: Boolean = true, initialScroll: Scroll.Absolute = Scroll.Absolute.Start, autoScroll: Scroll = initialScroll, autoScrollCondition: AutoScrollCondition = AutoScrollCondition.Never, autoScrollInterpolator: TimeInterpolator = AccelerateDecelerateInterpolator(), autoScrollDuration: Long = Animation.DIFF_DURATION.toLong())

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

Constructors

ScrollHandler

constructor(scrollEnabled: Boolean = true, initialScroll: Scroll.Absolute = Scroll.Absolute.Start, autoScroll: Scroll = initialScroll, autoScrollCondition: AutoScrollCondition = AutoScrollCondition.Never, autoScrollInterpolator: TimeInterpolator = AccelerateDecelerateInterpolator(), autoScrollDuration: Long = Animation.DIFF_DURATION.toLong())

Types

Listener

interface Listener

Facilitates listening for scroll events.

Properties

maxValue

var maxValue: Float

The maximum scroll value (in pixels).

value

var value: Float

The current scroll value (in pixels).

Functions

addListener

fun addListener(listener: ScrollHandler.Listener): Boolean

Adds the provided Listener.

animateScroll

fun animateScroll(scroll: Scroll, interpolator: TimeInterpolator = AccelerateDecelerateInterpolator(), duration: Long = Animation.DIFF_DURATION.toLong())