Simple status box for the sidebar.
[elgg_plugins.git] / yui / docs / YAHOO.util.Scroll.html
blobe29fa09f2360e2711784787408ec66a8bb4d2015
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <title>API: animation YAHOO.util.Scroll (YUI Library)</title>
5 <link rel="stylesheet" type="text/css" href="assets/api.css">
6 </head>
8 <body id="yahoo-com">
9 <div id="doc3" class="yui-t2">
11 <div id="hd">
12 <h1>Yahoo! UI Library</h1>
13 <h3>animation&nbsp; <span class="subtitle">2.2.0</span></h3>
14 <p>
15 <a href="./index.html">Yahoo! UI Library</a>
16 &gt; <a href="./module_animation.html">animation</a>
17 &gt; YAHOO.util.Scroll
19 </p>
20 </div>
22 <div id="bd">
23 <div id="yui-main">
24 <div class="yui-b">
27 <h2>
32 Class <b>YAHOO.util.Scroll</b>
33 <span class="extends">
34 - extends <a href="YAHOO.util.Anim.html">YAHOO.util.Anim</a>
35 </span>
37 <span class="extends">
38 </span>
40 </code>
41 </h2>
42 <!-- class tree goes here -->
47 <div class="summary description">
48 Anim subclass for scrolling elements to a position defined by the "scroll"
49 member of "attributes". All "scroll" members are arrays with x, y scroll positions.
50 <p>Usage: <code>var myAnim = new YAHOO.util.Scroll(el, { scroll: { to: [0, 800] } }, 1, YAHOO.util.Easing.easeOut);</code></p>
51 </div>
53 <div class="section constructor details">
54 <h3><a name="constructor_detail">Constructor</a></h3>
55 <div class="content">
56 <div class="detail">
57 <strong>YAHOO.util.Scroll</strong>
58 <code>
66 attributes
69 duration
72 method
74 </code>
75 <div class="description">
76 <dl>
77 <dt>Parameters:</dt>
78 <dd>
79 <code>el
80 &lt;String or HTMLElement&gt;
81 </code>
82 Reference to the element that will be animated
83 </dd>
84 <dd>
85 <code>attributes
86 &lt;Object&gt;
87 </code>
88 The attribute(s) to be animated.
89 Each attribute is an object with at minimum a "to" or "by" member defined.
90 Additional optional members are "from" (defaults to current value), "units" (defaults to "px").
91 All attribute names use camelCase.
92 </dd>
93 <dd>
94 <code>duration
95 &lt;Number&gt;
96 </code>
97 (optional, defaults to 1 second) Length of animation (frames or seconds), defaults to time-based
98 </dd>
99 <dd>
100 <code>method
101 &lt;Function&gt;
102 </code>
103 (optional, defaults to YAHOO.util.Easing.easeNone) Computes the values that are applied to the attributes per frame (generally a YAHOO.util.Easing method)
104 </dd>
105 </dl>
108 </div>
109 </div>
110 </div>
111 </div>
114 <div class="section field inheritance">
115 <h4>Properties inherited from <a href="YAHOO.util.Anim.html">YAHOO.util.Anim</a>:</h4>
116 <div class="content">
117 <code>
119 <a href="YAHOO.util.Anim.html#_onComplete">_onComplete</a>,
120 <a href="YAHOO.util.Anim.html#_onStart">_onStart</a>,
121 <a href="YAHOO.util.Anim.html#_onTween">_onTween</a>,
122 <a href="YAHOO.util.Anim.html#actualFrames">actualFrames</a>,
123 <a href="YAHOO.util.Anim.html#attributes">attributes</a>,
124 <a href="YAHOO.util.Anim.html#currentFrame">currentFrame</a>,
125 <a href="YAHOO.util.Anim.html#duration">duration</a>,
126 <a href="YAHOO.util.Anim.html#el">el</a>,
127 <a href="YAHOO.util.Anim.html#isAnimated">isAnimated</a>,
128 <a href="YAHOO.util.Anim.html#method">method</a>,
129 <a href="YAHOO.util.Anim.html#startTime">startTime</a>,
130 <a href="YAHOO.util.Anim.html#totalFrames">totalFrames</a>,
131 <a href="YAHOO.util.Anim.html#useSeconds">useSeconds</a>
132 </code>
133 </div>
134 </div>
137 <div class="section field inheritance">
138 <h4>Methods inherited from <a href="YAHOO.util.Anim.html">YAHOO.util.Anim</a>:</h4>
139 <div class="content">
140 <code>
142 <a href="YAHOO.util.Anim.html#animate">animate</a>,
143 <a href="YAHOO.util.Anim.html#doMethod">doMethod</a>,
144 <a href="YAHOO.util.Anim.html#getAttribute">getAttribute</a>,
145 <a href="YAHOO.util.Anim.html#getDefaultUnit">getDefaultUnit</a>,
146 <a href="YAHOO.util.Anim.html#getEl">getEl</a>,
147 <a href="YAHOO.util.Anim.html#getStartTime">getStartTime</a>,
148 <a href="YAHOO.util.Anim.html#init">init</a>,
149 <a href="YAHOO.util.Anim.html#isAnimated">isAnimated</a>,
150 <a href="YAHOO.util.Anim.html#onTween">onTween</a>,
151 <a href="YAHOO.util.Anim.html#setAttribute">setAttribute</a>,
152 <a href="YAHOO.util.Anim.html#setRuntimeAttribute">setRuntimeAttribute</a>,
153 <a href="YAHOO.util.Anim.html#stop">stop</a>,
154 <a href="YAHOO.util.Anim.html#toString">toString</a>
155 </code>
156 </div>
157 </div>
161 <div class="section field inheritance">
162 <h4>Events inherited from <a href="YAHOO.util.Anim.html">YAHOO.util.Anim</a>:</h4>
163 <div class="content">
164 <code>
166 <a href="YAHOO.util.Anim.html#onComplete">onComplete</a>,
167 <a href="YAHOO.util.Anim.html#onStart">onStart</a>,
168 <a href="YAHOO.util.Anim.html#onTween">onTween</a>
169 </code>
170 </div>
171 </div>
175 </div>
176 </div>
177 <div class="yui-b">
178 <div class="nav">
180 <div class="module">
181 <h4>Modules</h4>
182 <ul class="content">
184 <li class="selected"><a href="module_animation.html">animation</a></li>
186 <li class=""><a href="module_autocomplete.html">autocomplete</a></li>
188 <li class=""><a href="module_button.html">button</a></li>
190 <li class=""><a href="module_calendar.html">calendar</a></li>
192 <li class=""><a href="module_connection.html">connection</a></li>
194 <li class=""><a href="module_container.html">container</a></li>
196 <li class=""><a href="module_datasource.html">datasource</a></li>
198 <li class=""><a href="module_datatable.html">datatable</a></li>
200 <li class=""><a href="module_dom.html">dom</a></li>
202 <li class=""><a href="module_dragdrop.html">dragdrop</a></li>
204 <li class=""><a href="module_element.html">element</a></li>
206 <li class=""><a href="module_event.html">event</a></li>
208 <li class=""><a href="module_history.html">history</a></li>
210 <li class=""><a href="module_logger.html">logger</a></li>
212 <li class=""><a href="module_menu.html">menu</a></li>
214 <li class=""><a href="module_slider.html">slider</a></li>
216 <li class=""><a href="module_tabview.html">tabview</a></li>
218 <li class=""><a href="module_treeview.html">treeview</a></li>
220 <li class=""><a href="module_yahoo.html">yahoo</a></li>
221 </ul>
222 </div>
224 <div class="module">
225 <h4>Classes</h4>
226 <ul class="content">
227 <li class=""><a href="YAHOO.util.Anim.html">YAHOO.util.Anim</a></li>
228 <li class=""><a href="YAHOO.util.AnimMgr.html">YAHOO.util.AnimMgr</a></li>
229 <li class=""><a href="YAHOO.util.Bezier.html">YAHOO.util.Bezier</a></li>
230 <li class=""><a href="YAHOO.util.ColorAnim.html">YAHOO.util.ColorAnim</a></li>
231 <li class=""><a href="YAHOO.util.Easing.html">YAHOO.util.Easing</a></li>
232 <li class=""><a href="YAHOO.util.Motion.html">YAHOO.util.Motion</a></li>
233 <li class="selected"><a href="YAHOO.util.Scroll.html">YAHOO.util.Scroll</a></li>
234 </ul>
235 </div>
237 <div class="module">
238 <h4>Files</h4>
239 <ul class="content">
240 <li class=""><a href="Anim.js.html">Anim.js</a></li>
241 <li class=""><a href="AnimMgr.js.html">AnimMgr.js</a></li>
242 <li class=""><a href="Bezier.js.html">Bezier.js</a></li>
243 <li class=""><a href="ColorAnim.js.html">ColorAnim.js</a></li>
244 <li class=""><a href="Easing.js.html">Easing.js</a></li>
245 <li class=""><a href="Motion.js.html">Motion.js</a></li>
246 <li class=""><a href="Scroll.js.html">Scroll.js</a></li>
247 </ul>
248 </div>
254 </div>
255 </div>
256 </div>
257 <div id="ft">
258 <hr />
259 Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
260 </div>
261 </div>
262 </body>
263 </html>