Classes

Files

Class YAHOO.util.Scroll

Object
   |
   +--YAHOO.util.Anim
         |
         +--YAHOO.util.ColorAnim
               |
               +--YAHOO.util.Scroll
class YAHOO.util.Scroll
extends YAHOO.util.ColorAnim
Requires:
YAHOO.util.Anim
YAHOO.util.AnimMgr
YAHOO.util.Easing
YAHOO.util.Bezier
YAHOO.util.ColorAnim
YAHOO.util.Dom
YAHOO.util.Event
YAHOO.util.CustomEvent

Anim subclass for scrolling elements to a position defined by the "scroll" member of "attributes". All "scroll" members are arrays with x, y scroll positions.

Usage: var myAnim = new YAHOO.util.Scroll(el, { scroll: { to: [0, 800] } }, 1, YAHOO.util.Easing.easeOut);

Quick Links:  Constructor Summary Constructor Details

Fields inherited from class YAHOO.util.Anim [top]

attributes, duration, method, useSeconds, currentFrame, totalFrames, onStart, onTween, onComplete

Constructor Summary [top]

YAHOO.util.Scroll
 

Methods inherited from class YAHOO.util.ColorAnim

toString, parseColor, getAttribute, doMethod

Methods inherited from class YAHOO.util.Anim

setAttribute, getDefaultUnit, init, getEl, isAnimated, getStartTime, animate, stop

Constructor Detail [top]

YAHOO.util.Scroll

YAHOO.util.Scroll ()
Parameters:
String - or HTMLElement} el Reference to the element that will be animated
attributes - The attribute(s) to be animated. Each attribute is an object with at minimum a "to" or "by" member defined. Additional optional members are "from" (defaults to current value), "units" (defaults to "px"). All attribute names use camelCase.
duration - (optional, defaults to 1 second) Length of animation (frames or seconds), defaults to time-based
method - (optional, defaults to YAHOO.util.Easing.easeNone) Computes the values that are applied to the attributes per frame (generally a YAHOO.util.Easing method)