Classes

Files

Class YAHOO.util.Scroll

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

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 | Method Summary | Constructor Details | Method Details

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

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

Constructor Summary [top]

YAHOO.util.Scroll
Anim subclass for scrolling elements to a position defined by the "scroll" member of "attributes". 

Method Summary [top]

Number doMethod (<String> attribute, <Number> start, <Number> end)
Returns the value computed by the animation's "method". 
Number getAttribute (<String> attribute)
Returns current value of the attribute. 
void setAttribute (<String> attribute, <Number> val, <String> unit)
Applies a value to an attribute 

Methods inherited from class YAHOO.util.Anim

init, getEl, setDefault, getDefault, isAnimated, getStartTime, animate, stop

Constructor Detail [top]

YAHOO.util.Scroll

YAHOO.util.Scroll ()
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);

Parameters:
HTMLElement - | String} 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)

Method Detail [top]

doMethod

Number doMethod (<String> attribute, <Number> start, <Number> end)
Returns the value computed by the animation's "method".
Parameters:
attribute - The name of the attribute.
start - The value this attribute should start from for this animation.
end - The value this attribute should end at for this animation.
Returns:
The Value to be applied to the attribute.

getAttribute

Number getAttribute (<String> attribute)
Returns current value of the attribute.
Parameters:
attribute - The name of the attribute.
Returns:
val The current value of the attribute.

setAttribute

void setAttribute (<String> attribute, <Number> val, <String> unit)
Applies a value to an attribute
Parameters:
attribute - The name of the attribute.
val - The value to be applied to the attribute.
unit - The unit ('px', '%', etc.) of the value.