docs/output/Ext.Fx.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.Fx-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.Fx-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.Fx-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.Fx-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.Fx"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/Fx.html#cls-Ext.Fx">Ext.Fx</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">Fx.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Fx.html#cls-Ext.Fx">Fx</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr><tr><td class="hd-info"></td></tr></table><div class="description"><p>A class to provide basic animation and visual effects support.  <b>Note:</b> This class is automatically applied\r
   2 to the <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> interface when included, so all effects calls should be performed via <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a>.\r
   3 Conversely, since the effects are not actually defined in <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a>, Ext.Fx <b>must</b> be\r
   4 <a href="output/Ext.html#Ext-enableFx" ext:member="enableFx" ext:cls="Ext">included</a> in order for the Element effects to work.</p><br/>\r
   5 <p><b><u>Method Chaining</u></b></p>\r
   6 <p>It is important to note that although the Fx methods and many non-Fx Element methods support "method chaining" in that\r
   7 they return the Element object itself as the method return value, it is not always possible to mix the two in a single\r
   8 method chain.  The Fx methods use an internal effects queue so that each effect can be properly timed and sequenced.\r
   9 Non-Fx methods, on the other hand, have no such internal queueing and will always execute immediately.  For this reason,\r
  10 while it may be possible to mix certain Fx and non-Fx method calls in a single chain, it may not always provide the\r
  11 expected results and should be done with care.  Also see <tt><a href="output/Ext.Fx.html#Ext.Fx-callback" ext:member="callback" ext:cls="Ext.Fx">callback</a></tt>.</p><br/>\r
  12 <p><b><u>Anchor Options for Motion Effects</u></b></p>\r
  13 <p>Motion effects support 8-way anchoring, meaning that you can choose one of 8 different anchor points on the Element\r
  14 that will serve as either the start or end point of the animation.  Following are all of the supported anchor positions:</p>\r
  15 <pre>\r
  16 Value  Description\r
  17 -----  -----------------------------\r
  18 tl     The top left corner\r
  19 t      The center of the top edge\r
  20 tr     The top right corner\r
  21 l      The center of the left edge\r
  22 r      The center of the right edge\r
  23 bl     The bottom left corner\r
  24 b      The center of the bottom edge\r
  25 br     The bottom right corner\r
  26 </pre>\r
  27 <b>Note</b>: some Fx methods accept specific custom config parameters.  The options shown in the Config Options\r
  28 section below are common options that can be passed to any Fx method unless otherwise noted.</b></div><div class="hr"></div><a id="Ext.Fx-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-afterCls"></a><b><a href="source/Fx.html#cfg-Ext.Fx-afterCls">afterCls</a></b> : String<div class="mdesc">A css class to apply after the effect</div></td><td class="msource">Fx</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-afterStyle"></a><b><a href="source/Fx.html#cfg-Ext.Fx-afterStyle">afterStyle</a></b> : String/Object/Function<div class="mdesc"><div class="short">A style specification string, e.g. "width:100px", or an object&#13;\r
  29 in the form {width:"100px"}, or a function which retu...</div><div class="long">A style specification string, e.g. <tt>"width:100px"</tt>, or an object\r
  30 in the form <tt>{width:"100px"}</tt>, or a function which returns such a specification that will be applied to the\r
  31 Element after the effect finishes.</div></div></td><td class="msource">Fx</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-block"></a><b><a href="source/Fx.html#cfg-Ext.Fx-block">block</a></b> : Boolean<div class="mdesc">Whether the effect should block other effects from queueing while it runs</div></td><td class="msource">Fx</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-callback"></a><b><a href="source/Fx.html#cfg-Ext.Fx-callback">callback</a></b> : Function<div class="mdesc"><div class="short">A function called when the effect is finished.  Note that effects are queued internally by the&#13;\r
  32 Fx class, so a callba...</div><div class="long">A function called when the effect is finished.  Note that effects are queued internally by the\r
  33 Fx class, so a callback is not required to specify another effect -- effects can simply be chained together\r
  34 and called in sequence (see note for <b><u>Method Chaining</u></b> above), for example:<pre><code>el.slideIn().highlight();</code></pre>\r
  35 The callback is intended for any additional code that should run once a particular effect has completed. The Element\r
  36 being operated upon is passed as the first parameter.</div></div></td><td class="msource">Fx</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-concurrent"></a><b><a href="source/Fx.html#cfg-Ext.Fx-concurrent">concurrent</a></b> : Boolean<div class="mdesc"><div class="short">Whether to allow subsequently-queued effects to run at the same time as the current effect, or to ensure that they ru...</div><div class="long">Whether to allow subsequently-queued effects to run at the same time as the current effect, or to ensure that they run in sequence</div></div></td><td class="msource">Fx</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-duration"></a><b><a href="source/Fx.html#cfg-Ext.Fx-duration">duration</a></b> : Number<div class="mdesc">The length of time (in seconds) that the effect should last</div></td><td class="msource">Fx</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-easing"></a><b><a href="source/Fx.html#cfg-Ext.Fx-easing">easing</a></b> : String<div class="mdesc"><div class="short">A valid Ext.lib.Easing value for the effect:&lt;div class="mdetail-params"&gt;&#13;\r
  37 backBoth&#13;\r
  38 backIn&#13;\r
  39 backOut&#13;\r
  40 bounceBoth&#13;\r
  41 boun...</div><div class="long">A valid Ext.lib.Easing value for the effect:</p><div class="mdetail-params"><ul>\r
  42 <li><b><tt>backBoth</tt></b></li>\r
  43 <li><b><tt>backIn</tt></b></li>\r
  44 <li><b><tt>backOut</tt></b></li>\r
  45 <li><b><tt>bounceBoth</tt></b></li>\r
  46 <li><b><tt>bounceIn</tt></b></li>\r
  47 <li><b><tt>bounceOut</tt></b></li>\r
  48 <li><b><tt>easeBoth</tt></b></li>\r
  49 <li><b><tt>easeBothStrong</tt></b></li>\r
  50 <li><b><tt>easeIn</tt></b></li>\r
  51 <li><b><tt>easeInStrong</tt></b></li>\r
  52 <li><b><tt>easeNone</tt></b></li>\r
  53 <li><b><tt>easeOut</tt></b></li>\r
  54 <li><b><tt>easeOutStrong</tt></b></li>\r
  55 <li><b><tt>elasticBoth</tt></b></li>\r
  56 <li><b><tt>elasticIn</tt></b></li>\r
  57 <li><b><tt>elasticOut</tt></b></li>\r
  58 </ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-endOpacity"></a><b><a href="source/Fx.html#cfg-Ext.Fx-endOpacity">endOpacity</a></b> : Number<div class="mdesc">Only applicable for <a href="output/Ext.Fx.html#Ext.Fx-fadeIn" ext:member="fadeIn" ext:cls="Ext.Fx">fadeIn</a> or <a href="output/Ext.Fx.html#Ext.Fx-fadeOut" ext:member="fadeOut" ext:cls="Ext.Fx">fadeOut</a>, a number between\r
  59 <tt>0</tt> and <tt>1</tt> inclusive to configure the ending opacity value.</div></td><td class="msource">Fx</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-remove"></a><b><a href="source/Fx.html#cfg-Ext.Fx-remove">remove</a></b> : Boolean<div class="mdesc">Whether the Element should be removed from the DOM and destroyed after the effect finishes</div></td><td class="msource">Fx</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-scope"></a><b><a href="source/Fx.html#cfg-Ext.Fx-scope">scope</a></b> : Object<div class="mdesc">The scope (<code>this</code> reference) in which the <tt><a href="output/Ext.Fx.html#Ext.Fx-callback" ext:member="callback" ext:cls="Ext.Fx">callback</a></tt> function is executed. Defaults to the browser window.</div></td><td class="msource">Fx</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-stopFx"></a><b><a href="source/Fx.html#cfg-Ext.Fx-stopFx">stopFx</a></b> : Boolean<div class="mdesc"><div class="short">Whether preceding effects should be stopped and removed before running current effect (only applies to non blocking e...</div><div class="long">Whether preceding effects should be stopped and removed before running current effect (only applies to non blocking effects)</div></div></td><td class="msource">Fx</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-useDisplay"></a><b><a href="source/Fx.html#cfg-Ext.Fx-useDisplay">useDisplay</a></b> : Boolean<div class="mdesc"><div class="short">Whether to use the display CSS property instead of visibility when hiding Elements (only applies to &#13;\r
  60 effects that en...</div><div class="long">Whether to use the <i>display</i> CSS property instead of <i>visibility</i> when hiding Elements (only applies to \r
  61 effects that end with the element being visually hidden, ignored otherwise)</div></div></td><td class="msource">Fx</td></tr></tbody></table><a id="Ext.Fx-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.Fx-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-fadeIn"></a><b><a href="source/Fx.html#method-Ext.Fx-fadeIn">fadeIn</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
  62     :\r
  63                                         Ext.Element<div class="mdesc"><div class="short">Fade an element in (from transparent to opaque).  The ending opacity can be specified&#13;\r
  64 using the endOpacity config op...</div><div class="long">Fade an element in (from transparent to opaque).  The ending opacity can be specified\r
  65 using the <tt><a href="output/Ext.Fx.html#Ext.Fx-endOpacity" ext:member="endOpacity" ext:cls="Ext.Fx">endOpacity</a></tt> config option.\r
  66 Usage:\r
  67 <pre><code><i>// <b>default</b>: fade <b>in</b> from opacity 0 to 100%\r</i>
  68 el.fadeIn();\r
  69 \r
  70 <i>// custom: fade <b>in</b> from opacity 0 to 75% over 2 seconds\r</i>
  71 el.fadeIn({ endOpacity: .75, duration: 2});\r
  72 \r
  73 <i>// common config options shown <b>with</b> <b>default</b> values\r</i>
  74 el.fadeIn({\r
  75     endOpacity: 1, <i>//can be any value between 0 and 1 (e.g. .5)\r</i>
  76     easing: <em>'easeOut'</em>,\r
  77     duration: .5\r
  78 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-fadeOut"></a><b><a href="source/Fx.html#method-Ext.Fx-fadeOut">fadeOut</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
  79     :\r
  80                                         Ext.Element<div class="mdesc"><div class="short">Fade an element out (from opaque to transparent).  The ending opacity can be specified&#13;\r
  81 using the endOpacity config o...</div><div class="long">Fade an element out (from opaque to transparent).  The ending opacity can be specified\r
  82 using the <tt><a href="output/Ext.Fx.html#Ext.Fx-endOpacity" ext:member="endOpacity" ext:cls="Ext.Fx">endOpacity</a></tt> config option.  Note that IE may require\r
  83 <tt><a href="output/Ext.Fx.html#Ext.Fx-useDisplay" ext:member="useDisplay" ext:cls="Ext.Fx">useDisplay</a>:true</tt> in order to redisplay correctly.\r
  84 Usage:\r
  85 <pre><code><i>// <b>default</b>: fade out from the element<em>'s current opacity to 0\r</i>
  86 el.fadeOut();\r
  87 \r
  88 <i>// custom: fade out from the element'</em>s current opacity to 25% over 2 seconds\r</i>
  89 el.fadeOut({ endOpacity: .25, duration: 2});\r
  90 \r
  91 <i>// common config options shown <b>with</b> <b>default</b> values\r</i>
  92 el.fadeOut({\r
  93     endOpacity: 0, <i>//can be any value between 0 and 1 (e.g. .5)\r</i>
  94     easing: <em>'easeOut'</em>,\r
  95     duration: .5,\r
  96     remove: false,\r
  97     useDisplay: false\r
  98 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-frame"></a><b><a href="source/Fx.html#method-Ext.Fx-frame">frame</a></b>(&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;color</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;count</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
  99     :\r
 100                                         Ext.Element<div class="mdesc"><div class="short">Shows a ripple of exploding, attenuating borders to draw attention to an Element.&#13;\r
 101 Usage:&#13;\r
 102 // default: a single light...</div><div class="long">Shows a ripple of exploding, attenuating borders to draw attention to an Element.\r
 103 Usage:\r
 104 <pre><code><i>// <b>default</b>: a single light blue ripple\r</i>
 105 el.frame();\r
 106 \r
 107 <i>// custom: 3 red ripples lasting 3 seconds total\r</i>
 108 el.frame(<em>"ff0000"</em>, 3, { duration: 3 });\r
 109 \r
 110 <i>// common config options shown <b>with</b> <b>default</b> values\r</i>
 111 el.frame(<em>"C3DAF9"</em>, 1, {\r
 112     duration: 1 <i>//duration of each individual ripple.\r</i>
 113     <i>// Note: Easing is not configurable and will be ignored <b>if</b> included\r</i>
 114 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>color</code> : String<div class="sub-desc">(optional) The color of the border.  Should be a 6 char hex color without the leading # (defaults to light blue: 'C3DAF9').</div></li><li><code>count</code> : Number<div class="sub-desc">(optional) The number of ripples to display (defaults to 1)</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-ghost"></a><b><a href="source/Fx.html#method-Ext.Fx-ghost">ghost</a></b>(&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;anchor</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
 115     :\r
 116                                         Ext.Element<div class="mdesc"><div class="short">Slides the element while fading it out of view.  An anchor point can be optionally passed to set the &#13;\r
 117 ending point o...</div><div class="long">Slides the element while fading it out of view.  An anchor point can be optionally passed to set the \r
 118 ending point of the effect.\r
 119 Usage:\r
 120 <pre><code><i>// <b>default</b>: slide the element downward <b>while</b> fading out\r</i>
 121 el.ghost();\r
 122 \r
 123 <i>// custom: slide the element out to the right <b>with</b> a 2-second duration\r</i>
 124 el.ghost(<em>'r'</em>, { duration: 2 });\r
 125 \r
 126 <i>// common config options shown <b>with</b> <b>default</b> values\r</i>
 127 el.ghost(<em>'b'</em>, {\r
 128     easing: <em>'easeOut'</em>,\r
 129     duration: .5,\r
 130     remove: false,\r
 131     useDisplay: false\r
 132 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>anchor</code> : String<div class="sub-desc">(optional) One of the valid Fx anchor positions (defaults to bottom: 'b')</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-hasActiveFx"></a><b><a href="source/Fx.html#method-Ext.Fx-hasActiveFx">hasActiveFx</a></b>()\r
 133     :\r
 134                                         Boolean<div class="mdesc"><div class="short">Returns true if the element has any effects actively running or queued, else returns false.</div><div class="long">Returns true if the element has any effects actively running or queued, else returns false.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if element has active effects, else false</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-hasFxBlock"></a><b><a href="source/Fx.html#method-Ext.Fx-hasFxBlock">hasFxBlock</a></b>()\r
 135     :\r
 136                                         Boolean<div class="mdesc"><div class="short">Returns true if the element is currently blocking so that no other effect can be queued&#13;\r
 137 until this effect is finishe...</div><div class="long">Returns true if the element is currently blocking so that no other effect can be queued\r
 138 until this effect is finished, else returns false if blocking is not set.  This is commonly\r
 139 used to ensure that an effect initiated by a user action runs to completion prior to the\r
 140 same effect being restarted (e.g., firing only one effect even if the user clicks several times).<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if blocking, else false</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-highlight"></a><b><a href="source/Fx.html#method-Ext.Fx-highlight">highlight</a></b>(&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;color</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
 141     :\r
 142                                         Ext.Element<div class="mdesc"><div class="short">Highlights the Element by setting a color (applies to the background-color by default, but can be&#13;\r
 143 changed using the ...</div><div class="long">Highlights the Element by setting a color (applies to the background-color by default, but can be\r
 144 changed using the "attr" config option) and then fading back to the original color. If no original\r
 145 color is available, you should provide the "endColor" config option which will be cleared after the animation.\r
 146 Usage:\r
 147 <pre><code><i>// <b>default</b>: highlight background to yellow\r</i>
 148 el.highlight();\r
 149 \r
 150 <i>// custom: highlight foreground text to blue <b>for</b> 2 seconds\r</i>
 151 el.highlight(<em>"0000ff"</em>, { attr: <em>'color'</em>, duration: 2 });\r
 152 \r
 153 <i>// common config options shown <b>with</b> <b>default</b> values\r</i>
 154 el.highlight(<em>"ffff9c"</em>, {\r
 155     attr: <em>"background-color"</em>, <i>//can be any valid CSS property (attribute) that supports a color value\r</i>
 156     endColor: (current color) or <em>"ffffff"</em>,\r
 157     easing: <em>'easeIn'</em>,\r
 158     duration: 1\r
 159 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>color</code> : String<div class="sub-desc">(optional) The highlight color. Should be a 6 char hex color without the leading # (defaults to yellow: 'ffff9c')</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-pause"></a><b><a href="source/Fx.html#method-Ext.Fx-pause">pause</a></b>(&nbsp;<code>Number&nbsp;seconds</code>&nbsp;)\r
 160     :\r
 161                                         Ext.Element<div class="mdesc"><div class="short">Creates a pause before any subsequent queued effects begin.  If there are&#13;\r
 162 no effects queued after the pause it will ...</div><div class="long">Creates a pause before any subsequent queued effects begin.  If there are\r
 163 no effects queued after the pause it will have no effect.\r
 164 Usage:\r
 165 <pre><code>el.pause(1);</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>seconds</code> : Number<div class="sub-desc">The length of time to pause (in seconds)</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-puff"></a><b><a href="source/Fx.html#method-Ext.Fx-puff">puff</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
 166     :\r
 167                                         Ext.Element<div class="mdesc"><div class="short">Fades the element out while slowly expanding it in all directions.  When the effect is completed, the &#13;\r
 168 element will ...</div><div class="long">Fades the element out while slowly expanding it in all directions.  When the effect is completed, the \r
 169 element will be hidden (visibility = 'hidden') but block elements will still take up space in the document. \r
 170 The element must be removed from the DOM using the 'remove' config option if desired.\r
 171 Usage:\r
 172 <pre><code><i>// <b>default</b>\r</i>
 173 el.puff();\r
 174 \r
 175 <i>// common config options shown <b>with</b> <b>default</b> values\r</i>
 176 el.puff({\r
 177     easing: <em>'easeOut'</em>,\r
 178     duration: .5,\r
 179     remove: false,\r
 180     useDisplay: false\r
 181 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-scale"></a><b><a href="source/Fx.html#method-Ext.Fx-scale">scale</a></b>(&nbsp;<code>Number&nbsp;width</code>,&nbsp;<code>Number&nbsp;height</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
 182     :\r
 183                                         Ext.Element<div class="mdesc"><div class="short">Animates the transition of an element's dimensions from a starting height/width&#13;\r
 184 to an ending height/width.  This met...</div><div class="long">Animates the transition of an element's dimensions from a starting height/width\r
 185 to an ending height/width.  This method is a convenience implementation of <a href="output/shift.html" ext:cls="shift">shift</a>.\r
 186 Usage:\r
 187 <pre><code><i>// change height and width to 100x100 pixels\r</i>
 188 el.scale(100, 100);\r
 189 \r
 190 <i>// common config options shown <b>with</b> <b>default</b> values.  The height and width will <b>default</b> to\r</i>
 191 <i>// the element&#39;s existing values <b>if</b> passed as null.\r</i>
 192 el.scale(\r
 193     [element&#39;s width],\r
 194     [element&#39;s height], {\r
 195         easing: <em>'easeOut'</em>,\r
 196         duration: .35\r
 197     }\r
 198 );</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>width</code> : Number<div class="sub-desc">The new width (pass undefined to keep the original width)</div></li><li><code>height</code> : Number<div class="sub-desc">The new height (pass undefined to keep the original height)</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-sequenceFx"></a><b><a href="source/Fx.html#method-Ext.Fx-sequenceFx">sequenceFx</a></b>()\r
 199     :\r
 200                                         Ext.Element<div class="mdesc"><div class="short">Ensures that all effects queued after sequenceFx is called on the element are&#13;\r
 201 run in sequence.  This is the opposite...</div><div class="long">Ensures that all effects queued after sequenceFx is called on the element are\r
 202 run in sequence.  This is the opposite of <a href="output/Ext.Fx.html#Ext.Fx-syncFx" ext:member="syncFx" ext:cls="Ext.Fx">syncFx</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-shift"></a><b><a href="source/Fx.html#method-Ext.Fx-shift">shift</a></b>(&nbsp;<code>Object&nbsp;options</code>&nbsp;)\r
 203     :\r
 204                                         Ext.Element<div class="mdesc"><div class="short">Animates the transition of any combination of an element's dimensions, xy position and/or opacity.&#13;\r
 205 Any of these prop...</div><div class="long">Animates the transition of any combination of an element's dimensions, xy position and/or opacity.\r
 206 Any of these properties not specified in the config object will not be changed.  This effect \r
 207 requires that at least one new dimension, position or opacity setting must be passed in on\r
 208 the config object in order for the function to have any effect.\r
 209 Usage:\r
 210 <pre><code><i>// slide the element horizontally to x position 200 <b>while</b> changing the height and opacity\r</i>
 211 el.shift({ x: 200, height: 50, opacity: .8 });\r
 212 \r
 213 <i>// common config options shown <b>with</b> <b>default</b> values.\r</i>
 214 el.shift({\r
 215     width: [element&#39;s width],\r
 216     height: [element&#39;s height],\r
 217     x: [element&#39;s x position],\r
 218     y: [element&#39;s y position],\r
 219     opacity: [element&#39;s opacity],\r
 220     easing: <em>'easeOut'</em>,\r
 221     duration: .35\r
 222 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-slideIn"></a><b><a href="source/Fx.html#method-Ext.Fx-slideIn">slideIn</a></b>(&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;anchor</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
 223     :\r
 224                                         Ext.Element<div class="mdesc"><div class="short">Slides the element into view.  An anchor point can be optionally passed to set the point of&#13;\r
 225 origin for the slide eff...</div><div class="long">Slides the element into view.  An anchor point can be optionally passed to set the point of\r
 226 origin for the slide effect.  This function automatically handles wrapping the element with\r
 227 a fixed-size container if needed.  See the Fx class overview for valid anchor point options.\r
 228 Usage:\r
 229 <pre><code><i>// <b>default</b>: slide the element <b>in</b> from the top\r</i>
 230 el.slideIn();\r
 231 \r
 232 <i>// custom: slide the element <b>in</b> from the right <b>with</b> a 2-second duration\r</i>
 233 el.slideIn(<em>'r'</em>, { duration: 2 });\r
 234 \r
 235 <i>// common config options shown <b>with</b> <b>default</b> values\r</i>
 236 el.slideIn(<em>'t'</em>, {\r
 237     easing: <em>'easeOut'</em>,\r
 238     duration: .5\r
 239 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>anchor</code> : String<div class="sub-desc">(optional) One of the valid Fx anchor positions (defaults to top: 't')</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-slideOut"></a><b><a href="source/Fx.html#method-Ext.Fx-slideOut">slideOut</a></b>(&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;anchor</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
 240     :\r
 241                                         Ext.Element<div class="mdesc"><div class="short">Slides the element out of view.  An anchor point can be optionally passed to set the end point&#13;\r
 242 for the slide effect....</div><div class="long">Slides the element out of view.  An anchor point can be optionally passed to set the end point\r
 243 for the slide effect.  When the effect is completed, the element will be hidden (visibility = \r
 244 'hidden') but block elements will still take up space in the document.  The element must be removed\r
 245 from the DOM using the 'remove' config option if desired.  This function automatically handles \r
 246 wrapping the element with a fixed-size container if needed.  See the Fx class overview for valid anchor point options.\r
 247 Usage:\r
 248 <pre><code><i>// <b>default</b>: slide the element out to the top\r</i>
 249 el.slideOut();\r
 250 \r
 251 <i>// custom: slide the element out to the right <b>with</b> a 2-second duration\r</i>
 252 el.slideOut(<em>'r'</em>, { duration: 2 });\r
 253 \r
 254 <i>// common config options shown <b>with</b> <b>default</b> values\r</i>
 255 el.slideOut(<em>'t'</em>, {\r
 256     easing: <em>'easeOut'</em>,\r
 257     duration: .5,\r
 258     remove: false,\r
 259     useDisplay: false\r
 260 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>anchor</code> : String<div class="sub-desc">(optional) One of the valid Fx anchor positions (defaults to top: 't')</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-stopFx"></a><b><a href="source/Fx.html#method-Ext.Fx-stopFx">stopFx</a></b>()\r
 261     :\r
 262                                         Ext.Element<div class="mdesc"><div class="short">Stops any running effects and clears the element's internal effects queue if it contains&#13;\r
 263 any additional effects that...</div><div class="long">Stops any running effects and clears the element's internal effects queue if it contains\r
 264 any additional effects that haven't started yet.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-switchOff"></a><b><a href="source/Fx.html#method-Ext.Fx-switchOff">switchOff</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
 265     :\r
 266                                         Ext.Element<div class="mdesc"><div class="short">Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television).&#13;\r
 267 Wh...</div><div class="long">Blinks the element as if it was clicked and then collapses on its center (similar to switching off a television).\r
 268 When the effect is completed, the element will be hidden (visibility = 'hidden') but block elements will still \r
 269 take up space in the document. The element must be removed from the DOM using the 'remove' config option if desired.\r
 270 Usage:\r
 271 <pre><code><i>// <b>default</b>\r</i>
 272 el.switchOff();\r
 273 \r
 274 <i>// all config options shown <b>with</b> <b>default</b> values\r</i>
 275 el.switchOff({\r
 276     easing: <em>'easeIn'</em>,\r
 277     duration: .3,\r
 278     remove: false,\r
 279     useDisplay: false\r
 280 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">(optional) Object literal with any of the Fx config options</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Fx-syncFx"></a><b><a href="source/Fx.html#method-Ext.Fx-syncFx">syncFx</a></b>()\r
 281     :\r
 282                                         Ext.Element<div class="mdesc"><div class="short">Ensures that all effects queued after syncFx is called on the element are&#13;\r
 283 run concurrently.  This is the opposite of...</div><div class="long">Ensures that all effects queued after syncFx is called on the element are\r
 284 run concurrently.  This is the opposite of <a href="output/Ext.Fx.html#Ext.Fx-sequenceFx" ext:member="sequenceFx" ext:cls="Ext.Fx">sequenceFx</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element</div></li></ul></div></div></div></td><td class="msource">Fx</td></tr></tbody></table><a id="Ext.Fx-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>