VicoScrollState 2.0.3 API

```
public final class VicoScrollState

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

Field Summary

Fields
Modifier and Type	Field	Description
`private Float`	`value`
`private Float`	`maxValue`

Constructor Summary

Constructors
Constructor	Description
`VicoScrollState(Boolean scrollEnabled, Scroll.Absolute initialScroll, Scroll autoScroll, AutoScrollCondition autoScrollCondition, AnimationSpec<Float> autoScrollAnimationSpec)`	Houses information on a CartesianChart’s scroll value.

Method Summary

Modifier and Type	Method	Description
`final Float`	`getValue()`
`final Unit`	`setValue(Float value)`
`final Float`	`getMaxValue()`
`final Unit`	`setMaxValue(Float maxValue)`
`final Unit`	`scroll(Scroll scroll)`	Triggers a scroll.
`final Unit`	`animateScroll(Scroll scroll, AnimationSpec<Float> animationSpec)`	Triggers an animated scroll.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VicoScrollState
```
VicoScrollState(Boolean scrollEnabled, Scroll.Absolute initialScroll, Scroll autoScroll, AutoScrollCondition autoScrollCondition, AnimationSpec<Float> autoScrollAnimationSpec)
```
    Houses information on a CartesianChart’s scroll value.
    
    Parameters:
    
    scrollEnabled - whether scroll is enabled.
    
    initialScroll - represents the initial scroll value.
    
    autoScroll - represents the scroll value or delta for automatic scrolling.
    
    autoScrollCondition - defines when an automatic scroll should occur.
    
    autoScrollAnimationSpec - the AnimationSpec for automatic scrolling.
- Method Detail
  - getValue
```
 final Float getValue()
```
  - setValue
```
 final Unit setValue(Float value)
```
  - getMaxValue
```
 final Float getMaxValue()
```
  - setMaxValue
```
 final Unit setMaxValue(Float maxValue)
```
  - scroll
```
 final Unit scroll(Scroll scroll)
```
    Triggers a scroll.
  - animateScroll
```
 final Unit animateScroll(Scroll scroll, AnimationSpec<Float> animationSpec)
```
    Triggers an animated scroll.