class Scroller

Creates a new Scroller object with the given arguments.

The easing function to use when the scroll position goes outside of the minimum or maximum edge and bounces back.

See also:

• Scroller.ease

The height of the target's content. Will not scroll unless the height of the content is larger than the height of the target.

The width of the target's content. Will not scroll unless the width of the content is larger than the width of the target.

This value is used to decelerate the scroller when "thrown". The velocity of a throw is multiplied by this value once per millisecond to decelerate. A value greater than 0.0 and less than 1.0 is expected.

Determines if a touch is dragging the target horizontally (on the x-axis).

Determines if a touch is dragging the target vertically (on the y-axis).

The easing function to use when animating the scroll position.

Determines if the scrolling can go beyond the edges of the viewport and snap back to the minimum or maximum when released.

See also:

• Scroller.elasticity

The duration, measured in seconds, of the animation when a the scroller snaps back to the minimum or maximum position after going out of bounds.

If elasticEdges is false, this property is ignored.

If the scroll position goes outside the minimum or maximum bounds when the scroller's content is being actively dragged, the scrolling will be constrained using this multiplier. A value of 0.0 means that the scroller will not go beyond its minimum or maximum bounds. A value of 1.0 means that going beyond the minimum or maximum bounds is completely unrestrained.

If elasticEdges is false, this property is ignored.

See also:

• Scroller.elasticEdges

Determines if the target can be scrolled horizontally (on the x-axis).

Determines if the target can be scrolled vertically (on the y-axis).

Forces elasticity on the bottom edge, even if the height of the target's content is not larger than the width height the target.

If elasticEdges is false, this property is ignored.

See also:

• Scroller.elasticEdges

Forces elasticity on the left edge, even if the width of the target's content is not larger than the width of the target.

If elasticEdges is false, this property is ignored.

See also:

• Scroller.elasticEdges

Forces elasticity on the right edge, even if the width of the target's content is not larger than the width of the target.

If elasticEdges is false, this property is ignored.

See also:

• Scroller.elasticEdges

Forces elasticity on the top edge, even if the height of the target's content is not larger than the width height the target.

If elasticEdges is false, this property is ignored.

See also:

• Scroller.elasticEdges

The maximum horizontal scroll position.

The maximum vertical scroll position.

The minimum distance, measured in pixels, that the target must be dragged to begin scrolling.

The minimum horizontal scroll position.

The minimum vertical scroll position.

The distance to scroll when the mouse wheel is scrolled horizontally.

The distance to scroll when the mouse wheel is scrolled vertically.

The duration, measured in seconds, of the animation when scrolling with the mouse wheel.

Determines if rotating the mouse wheel vertically changes the scrollX position instead of scrollY.

Setting restrictedScrollX will clamp the value to the range between minScrollX and maxScrollX.

Setting restrictedScrollY will clamp the value to the range between minScrollY and maxScrollY.

The current horizontal scroll position.

When the value of the scrollX property changes, the scroller will dispatch an event of type ScrollEvent.SCROLL. This event is dispatched when other scroll position properties change too.

See also:

• feathers.events.ScrollEvent.SCROLL

The current vertical scroll position.

When the value of the scrollY property changes, the scroller will dispatch an event of type ScrollEvent.SCROLL. This event is dispatched when other scroll position properties change too.

See also:

• feathers.events.ScrollEvent.SCROLL

Determines if scrolling is currently active.

Determines if mouse events should be treated like touch events.

If not null, and the scroller is dragged with touch, the scrollX position is snapped to the nearest position in the array when the drag completes.

If not null, and the scroller is dragged with touch, the scrollY position is snapped to the nearest position in the array when the drag completes.

The container used for scrolling.

If the scroll position goes outside the minimum or maximum bounds when when the scroller's content is "thrown", the scrolling will be constrained using this multiplier. A value of 0.0 means that the scroller will not go beyond its minimum or maximum bounds. A value of 1.0 means that going beyond the minimum or maximum bounds is completely unrestrained.

If elasticEdges is false, this property is ignored.

See also:

• Scroller.elasticEdges

• Scroller.elasticity

The touch point that is currently dragging the scroll target. Returns null if no touch point is currently associated with the drag.

If simulateTouch is true, the touchPointIsSimulated property will indicate if the mouse is current dragging the scroll target.

See also:

• Scroller.touchPointIsSimulated

Returns true if the mouse is dragging the scroll target as a simulated touch point.

See also:

• Scroller.simulateTouch

• Scroller.touchPointID

The height of the target's scrollable region.

The width of the target's scrollable region.

Applies the minScrollX and maxScrollX restrictions to the current scrollX, and applies the minScrollY and maxScrollY restrictions to the current scrollY.

Updates the dimensions of both the target and its content.

Immediately stops any animation that affects the scrolling.

Immediately throws the scroller to the specified position, with optional animation. If you want to throw in only one direction, pass in null for the value that you do not want to change.