Interface ScrollToOptions

Index

Properties

Properties

optional public axis?: string

Which axis must be scrolled, use 'x', 'y', 'xy' or 'yx'.

optional public duration?: any

The OVERALL length of the animation.

optional public easing?: string

The easing method for the animation.

optional public margin?: boolean

If true, the margin of the target element will be deducted from the final position.

optional public offset?: any

Add/deduct from the end position. One number for both axes or { top:x, left:y }.

optional public onAfter?: () => void

Function to be called after the scrolling ends.

optional public onAfterFirst?: () => void

If queuing is activated, this function will be called after the first scrolling ends.

optional public over?: any

Add/deduct the height/width multiplied by 'over'. Can be { top:x, left:y } when using both axes.

optional public queue?: boolean

If true, and both axis are given. The 2nd axis will only be animated after the first one ends.