Fx. Scroll.js

Contains Fx.Scroll

License

MIT-style license.

Summary
Fx. Scroll.jsContains Fx.Scroll
Fx. ScrollScroll any element with an overflow, including the window element.
Properties
scrollToScrolls the chosen element to the x/y coordinates.
toTopScrolls the chosen element to its maximum top.
toBottomScrolls the chosen element to its maximum bottom.
toLeftScrolls the chosen element to its maximum left.
toRightScrolls the chosen element to its maximum right.
toElementScrolls the specified element to the position the passed in element is found.

Fx. Scroll

Scroll any element with an overflow, including the window element.  Inherits methods, properties, options and events from Fx.Base.

Note

Fx.Scroll requires an XHTML doctype.

Arguments

elementthe element to scroll
optionsoptional, see Options below.

Options

all the Fx.Base options and events, plus: offset - the distance for the scrollTo point/element. an Object with x/y properties. overflown - an array of nested scrolling containers, see Element.getPosition

Summary
Properties
scrollToScrolls the chosen element to the x/y coordinates.
toTopScrolls the chosen element to its maximum top.
toBottomScrolls the chosen element to its maximum bottom.
toLeftScrolls the chosen element to its maximum left.
toRightScrolls the chosen element to its maximum right.
toElementScrolls the specified element to the position the passed in element is found.

Properties

scrollTo

Scrolls the chosen element to the x/y coordinates.

Arguments

xthe x coordinate to scroll the element to
ythe y coordinate to scroll the element to

toTop

Scrolls the chosen element to its maximum top.

toBottom

Scrolls the chosen element to its maximum bottom.

toLeft

Scrolls the chosen element to its maximum left.

toRight

Scrolls the chosen element to its maximum right.

toElement

Scrolls the specified element to the position the passed in element is found.

Arguments

elthe $(element) to scroll the window to
Scroll any element with an overflow, including the window element.
Base class for the Effects.
Returns the real offsets of the element.

Documentation by Aaron Newton & Mootools Developers, generated by NaturalDocs and GeSHi