views/com.patrykandpatrick.vico.views.scroll/ChartScrollSpec

ChartScrollSpec

class ChartScrollSpec<in Model : ChartEntryModel>(val isScrollEnabled: Boolean = true, val initialScroll: InitialScroll = InitialScroll.Start, val autoScrollCondition: AutoScrollCondition<Model> = AutoScrollCondition.Never, val autoScrollInterpolator: TimeInterpolator = AccelerateDecelerateInterpolator(), val autoScrollDuration: Long = Animation.DIFF_DURATION.toLong())

Houses scrolling-related settings for charts.

Constructors

ChartScrollSpec

constructor(isScrollEnabled: Boolean = true, initialScroll: InitialScroll = InitialScroll.Start, autoScrollCondition: AutoScrollCondition<Model> = AutoScrollCondition.Never, autoScrollInterpolator: TimeInterpolator = AccelerateDecelerateInterpolator(), autoScrollDuration: Long = Animation.DIFF_DURATION.toLong())

Properties

autoScrollCondition

val autoScrollCondition: AutoScrollCondition<Model>

defines when an automatic scroll should be performed.

autoScrollDuration

val autoScrollDuration: Long

the animation duration for automatic scrolling.

autoScrollInterpolator

val autoScrollInterpolator: TimeInterpolator

the TimeInterpolator to use for automatic scrolling.

initialScroll

val initialScroll: InitialScroll

represents the chart’s initial scroll position.

isScrollEnabled

val isScrollEnabled: Boolean = true

whether horizontal scrolling is enabled.

Functions

copy

fun <Model : ChartEntryModel> ChartScrollSpec<Model>.copy(isScrollEnabled: Boolean = this.isScrollEnabled, initialScroll: InitialScroll = this.initialScroll, autoScrollCondition: AutoScrollCondition<Model> = this.autoScrollCondition, autoScrollInterpolator: TimeInterpolator = this.autoScrollInterpolator, autoScrollDuration: Long = this.autoScrollDuration): ChartScrollSpec<Model>

Copies this ChartScrollSpec, changing select values.

performAutoScroll

fun performAutoScroll(model: Model, oldModel: Model?, scrollHandler: ScrollHandler)

Performs an automatic scroll.