Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.draw.engine.Svg.html
1 <!DOCTYPE html><html><head><title>Ext.draw.engine.Svg | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.draw.engine.Svg',
13         docClass: 'Ext.draw.engine.Svg',
14         docReq: 'Ext.draw.engine.Svg',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Svg.html#Ext-draw.engine.Svg';
33     clsInfo = {"methods":["add","addEvents","addListener","addManagedListener","applyZIndex","capture","clearListeners","clearManagedListeners","create","destroy","enableBubble","fireEvent","getGroup","getId","getRegion","hasCls","hasListener","observe","on","relayEvents","releaseCapture","remove","removeAll","removeListener","removeManagedListener","resumeEvents","setSize","suspendEvents","un"],"cfgs":["height","listeners","width"],"properties":["addCls","addGradient","removeCls","setStyle","setText"],"events":[],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Svg.html#Ext-draw.engine.Svg" target="_blank">Ext.draw.engine.Svg</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.draw.Surface.html" rel="Ext.draw.Surface" class="cls docClass">Ext.draw.Surface</a><div class="subclass"><strong>Ext.draw.engine.Svg</strong></div></div><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>Provides specific methods to draw with SVG.</p>
38 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-height" class="member f inherited"><a href="Ext.draw.engine.Svg.html#config-height" rel="config-height" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-cfg-height" class="viewSource">view source</a></div><a name="height"></a><a name="config-height"></a><a href="Ext.draw.engine.Svg.html#" rel="config-height" class="cls expand">height</a><span> : Number</span></div><div class="description"><div class="short">The height of this component in pixels (defaults to auto).
39 Note to express this dimension as a percentage or offset s...</div><div class="long"><p>The height of this component in pixels (defaults to auto).
40 <b>Note</b> to express this dimension as a percentage or offset see <a href="Ext.Component.html#anchor" rel="Ext.Component#anchor" class="docClass">Ext.Component.anchor</a>.</p>
41 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.draw.engine.Svg.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.draw.engine.Svg.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
42 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
43 object during initialization.  This should be a valid listeners config object as specified in the
44 <a href="Ext.draw.engine.Svg.html#addListener" rel="Ext.draw.engine.Svg#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
45
46 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
47
48
49 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
50
51
52 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
53 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
54 events directly from a child element of a Component, we need to specify the <code>element</code> option to
55 identify the Component property to add a DOM listener to:</p>
56
57 <pre><code>new Ext.panel.Panel({
58     width: 400,
59     height: 200,
60     dockedItems: [{
61         xtype: 'toolbar'
62     }],
63     listeners: {
64         click: {
65             element: 'el', //bind to the underlying el property on the panel
66             fn: function(){ console.log('click el'); }
67         },
68         dblclick: {
69             element: 'body', //bind to the underlying body property on the panel
70             fn: function(){ console.log('dblclick body'); }
71         }
72     }
73 });
74 </code></pre>
75
76
77 <p></p></p>
78 </div></div></div><div id="config-width" class="member inherited"><a href="Ext.draw.engine.Svg.html#config-width" rel="config-width" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-cfg-width" class="viewSource">view source</a></div><a name="width"></a><a name="config-width"></a><a href="Ext.draw.engine.Svg.html#" rel="config-width" class="cls expand">width</a><span> : Number</span></div><div class="description"><div class="short">The width of this component in pixels (defaults to auto).
79 Note to express this dimension as a percentage or offset se...</div><div class="long"><p>The width of this component in pixels (defaults to auto).
80 <b>Note</b> to express this dimension as a percentage or offset see <a href="Ext.Component.html#anchor" rel="Ext.Component#anchor" class="docClass">Ext.Component.anchor</a>.</p>
81 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-addCls" class="member f inherited"><a href="Ext.draw.engine.Svg.html#property-addCls" rel="property-addCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-property-addCls" class="viewSource">view source</a></div><a name="addCls"></a><a name="property-addCls"></a><a href="Ext.draw.engine.Svg.html#" rel="property-addCls" class="cls expand">addCls</a><span> : Object</span></div><div class="description"><div class="short">Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.
82
83 For example:
84
85      dr...</div><div class="long"><p>Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.</p>
86
87 <p>For example:</p>
88
89 <pre><code>     drawComponent.surface.addCls(sprite, 'x-visible');
90 </code></pre>
91 </div></div></div><div id="property-addGradient" class="member inherited"><a href="Ext.draw.engine.Svg.html#property-addGradient" rel="property-addGradient" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-property-addGradient" class="viewSource">view source</a></div><a name="addGradient"></a><a name="property-addGradient"></a><a href="Ext.draw.engine.Svg.html#" rel="property-addGradient" class="cls expand">addGradient</a><span> : Object</span></div><div class="description"><div class="short">Add a gradient definition to the Surface. Note that in some surface engines, adding
92 a gradient via this method will n...</div><div class="long"><p>Add a gradient definition to the Surface. Note that in some surface engines, adding
93 a gradient via this method will not take effect if the surface has already been rendered.
94 Therefore, it is preferred to pass the gradients as an item to the surface config, rather
95 than calling this method, especially if the surface is rendered immediately (e.g. due to
96 'renderTo' in its config). For more information on how to create gradients in the Chart
97 configuration object please refer to <a href="Ext.chart.Chart.html" rel="Ext.chart.Chart" class="docClass">Ext.chart.Chart</a>.</p>
98
99 <p>The gradient object to be passed into this method is composed by:</p>
100
101 <ul>
102 <li><strong>id</strong> - string - The unique name of the gradient.</li>
103 <li><strong>angle</strong> - number, optional - The angle of the gradient in degrees.</li>
104 <li><p><strong>stops</strong> - object - An object with numbers as keys (from 0 to 100) and style objects as values.</p>
105
106 <p>  For example:</p>
107
108 <pre><code>         drawComponent.surface.addGradient({
109              id: 'gradientId',
110              angle: 45,
111              stops: {
112                  0: {
113                      color: '#555'
114                  },
115                  100: {
116                      color: '#ddd'
117                  }
118              }
119          });
120 </code></pre></li>
121 </ul>
122
123 </div></div></div><div id="property-removeCls" class="member inherited"><a href="Ext.draw.engine.Svg.html#property-removeCls" rel="property-removeCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-property-removeCls" class="viewSource">view source</a></div><a name="removeCls"></a><a name="property-removeCls"></a><a href="Ext.draw.engine.Svg.html#" rel="property-removeCls" class="cls expand">removeCls</a><span> : Object</span></div><div class="description"><div class="short">Removes one or more CSS classes from the element.
124
125 For example:
126
127  drawComponent.surface.removeCls(sprite, 'x-visible'...</div><div class="long"><p>Removes one or more CSS classes from the element.</p>
128
129 <p>For example:</p>
130
131 <pre><code> drawComponent.surface.removeCls(sprite, 'x-visible');
132 </code></pre>
133 </div></div></div><div id="property-setStyle" class="member inherited"><a href="Ext.draw.engine.Svg.html#property-setStyle" rel="property-setStyle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-property-setStyle" class="viewSource">view source</a></div><a name="setStyle"></a><a name="property-setStyle"></a><a href="Ext.draw.engine.Svg.html#" rel="property-setStyle" class="cls expand">setStyle</a><span> : Object</span></div><div class="description"><div class="short">Sets CSS style attributes to an element.
134
135 For example:
136
137  drawComponent.surface.setStyle(sprite, {
138      'cursor': 'poi...</div><div class="long"><p>Sets CSS style attributes to an element.</p>
139
140 <p>For example:</p>
141
142 <pre><code> drawComponent.surface.setStyle(sprite, {
143      'cursor': 'pointer'
144  });
145 </code></pre>
146 </div></div></div><div id="property-setText" class="member inherited"><a href="Ext.draw.engine.Svg.html#property-setText" rel="property-setText" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-property-setText" class="viewSource">view source</a></div><a name="setText"></a><a name="property-setText"></a><a href="Ext.draw.engine.Svg.html#" rel="property-setText" class="cls expand">setText</a><span> : Object</span></div><div class="description"><div class="short">Changes the text in the sprite element. The sprite must be a text sprite.
147 This method can also be called from Ext.dra...</div><div class="long"><p>Changes the text in the sprite element. The sprite must be a <code>text</code> sprite.
148 This method can also be called from <a href="Ext.draw.Sprite.html" rel="Ext.draw.Sprite" class="docClass">Ext.draw.Sprite</a>.</p>
149
150 <p>For example:</p>
151
152 <pre><code> var spriteGroup = drawComponent.surface.setText(sprite, 'my new text');
153 </code></pre>
154 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-add" class="member f inherited"><a href="Ext.draw.engine.Svg.html#method-add" rel="method-add" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-method-add" class="viewSource">view source</a></div><a name="add"></a><a name="method-add"></a><a href="Ext.draw.engine.Svg.html#" rel="method-add" class="cls expand">add</a> : void</div><div class="description"><div class="short">Add a Sprite to the surface. See Ext.draw.Sprite for the configuration object to be passed into this method.
155
156 For exa...</div><div class="long"><p>Add a Sprite to the surface. See <a href="Ext.draw.Sprite.html" rel="Ext.draw.Sprite" class="docClass">Ext.draw.Sprite</a> for the configuration object to be passed into this method.</p>
157
158 <p>For example:</p>
159
160 <pre><code>drawComponent.surface.add({
161     type: 'circle',
162     fill: '#ffc',
163     radius: 100,
164     x: 100,
165     y: 100
166 });
167 </code></pre>
168 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
169 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.draw.engine.Svg.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
170 <span class="pre">Object/String o, String </span>)
171  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
172 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
173 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
174 or the first event name string if multiple event names are being passed as separate parameters.</p>
175 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
176 Usage:</p>
177
178 <pre><code>this.addEvents('storeloaded', 'storecleared');
179 </code></pre>
180
181 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
182 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.draw.engine.Svg.html#" rel="method-addListener" class="cls expand">addListener</a>(
183 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
184  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
185 </div><div class="long"><p>Appends an event handler to this object.</p>
186 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
187 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
188 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
189 <b>If omitted, defaults to the object which fired the event.</b></p>
190 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
191 properties. This may contain any of the following properties:<ul>
192 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
193 <b>If omitted, defaults to the object which fired the event.</b></div></li>
194 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
195 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
196 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
197 by the specified number of milliseconds. If the event fires again within that time, the original
198 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
199 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
200 if the event was bubbled up from a child Observable.</div></li>
201 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
202 The name of a Component property which references an element to add a listener to.</p>
203
204 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
205 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
206 <pre><code>new Ext.panel.Panel({
207     title: 'The title',
208     listeners: {
209         click: this.handlePanelClick,
210         element: 'body'
211     }
212 });
213 </code></pre></p>
214
215
216 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
217
218
219 <p></div></li>
220 </ul><br></p>
221
222 <p>
223 <b>Combining Options</b><br>
224 Using the options argument, it is possible to combine different types of listeners:<br>
225 <br>
226 A delayed, one-time listener.
227 <pre><code>myPanel.on('hide', this.handleClick, this, {
228 single: true,
229 delay: 100
230 });</code></pre>
231 <p>
232 <b>Attaching multiple handlers in 1 call</b><br>
233 The method also allows for a single argument to be passed which is a config object containing properties
234 which specify multiple events. For example:
235 <pre><code>myGridPanel.on({
236     cellClick: this.onCellClick,
237     mouseover: this.onMouseOver,
238     mouseout: this.onMouseOut,
239     scope: this // Important. Ensure "this" is correct during handler execution
240 });
241 </code></pre>.
242 <p>
243
244 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
245 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.draw.engine.Svg.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
246 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
247  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
248 is destroyed.
249
250 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
251 is destroyed.
252
253 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
254 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
255 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
256 is the handler function.</p>
257 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
258 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
259 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
260 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
261 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
262 </li></ul></div></div></div><div id="method-applyZIndex" class="member ni"><a href="Ext.draw.engine.Svg.html#method-applyZIndex" rel="method-applyZIndex" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.engine.Svg.html" class="definedIn docClass">Ext.draw.engine.Svg</a><br/><a href="../source/Svg.html#Ext-draw.engine.Svg-method-applyZIndex" class="viewSource">view source</a></div><a name="applyZIndex"></a><a name="method-applyZIndex"></a><a href="Ext.draw.engine.Svg.html#" rel="method-applyZIndex" class="cls expand">applyZIndex</a>(
263 <span class="pre">Ext.draw.Sprite sprite</span>)
264  : void</div><div class="description"><div class="short"><p>Insert or move a given sprite's element to the correct place in the DOM list for its zIndex</p>
265 </div><div class="long"><p>Insert or move a given sprite's element to the correct place in the DOM list for its zIndex</p>
266 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sprite</span> : Ext.draw.Sprite<div class="sub-desc">
267 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
268 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.draw.engine.Svg.html#" rel="method-capture" class="cls expand">capture</a>(
269 <span class="pre">Observable o, Function fn, [Object scope]</span>)
270  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
271 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
272 to the supplied function with the event name + standard signature of the event
273 <b>before</b> the event is fired. If the supplied function returns false,
274 the event will not fire.</p>
275 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
276 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
277 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
278 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
279 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.draw.engine.Svg.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
280 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
281 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
282 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.draw.engine.Svg.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
283 </div><div class="long"><p>Removes all managed listeners for this object.</p>
284 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
285 </li></ul></div></div></div><div id="method-create" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-create" rel="method-create" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-method-create" class="viewSource">view source</a></div><a name="create"></a><a name="method-create"></a><a href="Ext.draw.engine.Svg.html#" rel="method-create" class="cls expand">create</a>(
286 <span class="pre">Object config, Array enginePriority</span>)
287  : void</div><div class="description"><div class="short"><p>Create and return a new concrete Surface instance appropriate for the current environment.</p>
288 </div><div class="long"><p>Create and return a new concrete Surface instance appropriate for the current environment.</p>
289 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Initial configuration for the Surface instance</p>
290 </div></li><li><span class="pre">enginePriority</span> : Array<div class="sub-desc"><p>Optional order of implementations to use; the first one that is</p>
291
292 <pre><code>           available in the current environment will be used. Defaults to
293            &lt;code&gt;['Svg', 'Vml']&lt;/code&gt;.
294 </code></pre>
295 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
296 </li></ul></div></div></div><div id="method-destroy" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-destroy" rel="method-destroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-method-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="method-destroy"></a><a href="Ext.draw.engine.Svg.html#" rel="method-destroy" class="cls expand">destroy</a> : void</div><div class="description"><div class="short">Destroys the surface. This is done by removing all components from it and
297 also removing its reference to a DOM elemen...</div><div class="long"><p>Destroys the surface. This is done by removing all components from it and
298 also removing its reference to a DOM element.</p>
299
300 <p>For example:</p>
301
302 <pre><code> drawComponent.surface.destroy();
303 </code></pre>
304 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
305 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.draw.engine.Svg.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
306 <span class="pre">String/Array events</span>)
307  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
308 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
309 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
310
311
312 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
313 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
314 access the required target more quickly.</p>
315
316
317 <p>Example:</p>
318
319
320 <pre><code>Ext.override(Ext.form.field.Base, {
321 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
322 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
323     this.enableBubble('change');
324 }),
325
326 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
327 getBubbleTarget : function() {
328     if (!this.formPanel) {
329         this.formPanel = this.findParentByType('form');
330     }
331     return this.formPanel;
332 }
333 });
334
335 var myForm = new Ext.formPanel({
336 title: 'User Details',
337 items: [{
338     ...
339 }],
340 listeners: {
341     change: function() {
342         // Title goes red if form has been modified.
343         myForm.header.setStyle('color', 'red');
344     }
345 }
346 });
347 </code></pre>
348
349 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
350 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
351 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.draw.engine.Svg.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
352 <span class="pre">String eventName, Object... args</span>)
353  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
354
355
356 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
357
358
359 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
360 by calling <a href="Ext.draw.engine.Svg.html#enableBubble" rel="Ext.draw.engine.Svg#enableBubble" class="docClass">enableBubble</a>.</p>
361
362 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
363 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
364 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
365 </li></ul></div></div></div><div id="method-getGroup" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-getGroup" rel="method-getGroup" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-method-getGroup" class="viewSource">view source</a></div><a name="getGroup"></a><a name="method-getGroup"></a><a href="Ext.draw.engine.Svg.html#" rel="method-getGroup" class="cls expand">getGroup</a>(
366 <span class="pre">String id</span>)
367  : Object</div><div class="description"><div class="short">Returns a new group or an existent group associated with the current surface.
368 The group returned is a Ext.draw.Compos...</div><div class="long"><p>Returns a new group or an existent group associated with the current surface.
369 The group returned is a <a href="Ext.draw.CompositeSprite.html" rel="Ext.draw.CompositeSprite" class="docClass">Ext.draw.CompositeSprite</a> group.</p>
370
371 <p>For example:</p>
372
373 <pre><code> var spriteGroup = drawComponent.surface.getGroup('someGroupId');
374 </code></pre>
375 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>The unique identifier of the group.</p>
376 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The <a href="Ext.draw.CompositeSprite.html" rel="Ext.draw.CompositeSprite" class="docClass">Ext.draw.CompositeSprite</a>.</p>
377 </li></ul></div></div></div><div id="method-getId" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-getId" rel="method-getId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-method-getId" class="viewSource">view source</a></div><a name="getId"></a><a name="method-getId"></a><a href="Ext.draw.engine.Svg.html#" rel="method-getId" class="cls expand">getId</a> : void</div><div class="description"><div class="short"><p>Retrieves the id of this component.
378 Will autogenerate an id if one has not already been set.</p>
379 </div><div class="long"><p>Retrieves the id of this component.
380 Will autogenerate an id if one has not already been set.</p>
381 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
382 </li></ul></div></div></div><div id="method-getRegion" class="member ni"><a href="Ext.draw.engine.Svg.html#method-getRegion" rel="method-getRegion" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.engine.Svg.html" class="definedIn docClass">Ext.draw.engine.Svg</a><br/><a href="../source/Svg.html#Ext-draw.engine.Svg-method-getRegion" class="viewSource">view source</a></div><a name="getRegion"></a><a name="method-getRegion"></a><a href="Ext.draw.engine.Svg.html#" rel="method-getRegion" class="cls expand">getRegion</a> : Ext.util.Region</div><div class="description"><div class="short"><p>Get the region for the surface's canvas area</p>
383 </div><div class="long"><p>Get the region for the surface's canvas area</p>
384 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Region</span>&nbsp; &nbsp;
385 </li></ul></div></div></div><div id="method-hasCls" class="member ni"><a href="Ext.draw.engine.Svg.html#method-hasCls" rel="method-hasCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.engine.Svg.html" class="definedIn docClass">Ext.draw.engine.Svg</a><br/><a href="../source/Svg.html#Ext-draw.engine.Svg-method-hasCls" class="viewSource">view source</a></div><a name="hasCls"></a><a name="method-hasCls"></a><a href="Ext.draw.engine.Svg.html#" rel="method-hasCls" class="cls expand">hasCls</a>(
386 <span class="pre">String className, Object className</span>)
387  : Boolean</div><div class="description"><div class="short"><p>Checks if the specified CSS class exists on this element's DOM node.</p>
388 </div><div class="long"><p>Checks if the specified CSS class exists on this element's DOM node.</p>
389 <h3 class="pa">Parameters</h3><ul><li><span class="pre">className</span> : String<div class="sub-desc"><p>The CSS class to check for</p>
390 </div></li><li><span class="pre">className</span> : Object<div class="sub-desc">
391 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the class exists, else false</p>
392 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.draw.engine.Svg.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
393 <span class="pre">String eventName</span>)
394  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
395 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
396 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
397 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
398 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.draw.engine.Svg.html#" rel="method-observe" class="cls expand">observe</a>(
399 <span class="pre">Function c, Object listeners</span>)
400  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
401
402 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
403
404 <p>This makes any event fired on any instance of the passed class also fire a single event through
405 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
406
407 <p>Usage:</p>
408
409 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
410 Ext.data.Connection.on('beforerequest', function(con, options) {
411     console.log('Ajax request made to ' + options.url);
412 });
413 </code></pre>
414 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
415 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.draw.engine.Svg.html#addListener" rel="Ext.draw.engine.Svg#addListener" class="docClass">addListener</a>.</p>
416 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
417 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.draw.engine.Svg.html#" rel="method-on" class="cls expand">on</a>(
418 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
419  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.draw.engine.Svg.html#addListener" rel="Ext.draw.engine.Svg#addListener" class="docClass">addListener</a>.)</p>
420 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.draw.engine.Svg.html#addListener" rel="Ext.draw.engine.Svg#addListener" class="docClass">addListener</a>.)</p>
421 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
422 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
423 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
424 <b>If omitted, defaults to the object which fired the event.</b></p>
425 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
426 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
427 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.draw.engine.Svg.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
428 <span class="pre">Object origin, Array events, Object prefix</span>)
429  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
430 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
431 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
432 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
433 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
434 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
435 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.draw.engine.Svg.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
436 <span class="pre">Observable o</span>)
437  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
438 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
439 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
440 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
441 </li></ul></div></div></div><div id="method-remove" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-remove" rel="method-remove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-method-remove" class="viewSource">view source</a></div><a name="remove"></a><a name="method-remove"></a><a href="Ext.draw.engine.Svg.html#" rel="method-remove" class="cls expand">remove</a>(
442 <span class="pre">Ext.draw.Sprite sprite, Boolean destroySprite</span>)
443  : Number</div><div class="description"><div class="short">Remove a given sprite from the surface, optionally destroying the sprite in the process.
444 You can also call the sprite...</div><div class="long"><p>Remove a given sprite from the surface, optionally destroying the sprite in the process.
445 You can also call the sprite own <code>remove</code> method.</p>
446
447 <p>For example:</p>
448
449 <pre><code> drawComponent.surface.remove(sprite);
450  //or...
451  sprite.remove();
452 </code></pre>
453 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sprite</span> : Ext.draw.Sprite<div class="sub-desc">
454 </div></li><li><span class="pre">destroySprite</span> : Boolean<div class="sub-desc">
455 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>the sprite's new index in the list</p>
456 </li></ul></div></div></div><div id="method-removeAll" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-removeAll" rel="method-removeAll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-method-removeAll" class="viewSource">view source</a></div><a name="removeAll"></a><a name="method-removeAll"></a><a href="Ext.draw.engine.Svg.html#" rel="method-removeAll" class="cls expand">removeAll</a>(
457 <span class="pre">Boolean destroySprites</span>)
458  : Number</div><div class="description"><div class="short">Remove all sprites from the surface, optionally destroying the sprites in the process.
459
460 For example:
461
462  drawComponent....</div><div class="long"><p>Remove all sprites from the surface, optionally destroying the sprites in the process.</p>
463
464 <p>For example:</p>
465
466 <pre><code> drawComponent.surface.removeAll();
467 </code></pre>
468 <h3 class="pa">Parameters</h3><ul><li><span class="pre">destroySprites</span> : Boolean<div class="sub-desc"><p>Whether to destroy all sprites when removing them.</p>
469 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The sprite's new index in the list.</p>
470 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.draw.engine.Svg.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
471 <span class="pre">String eventName, Function handler, [Object scope]</span>)
472  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
473 </div><div class="long"><p>Removes an event handler.</p>
474 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
475 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.draw.engine.Svg.html#addListener" rel="Ext.draw.engine.Svg#addListener" class="docClass">addListener</a> call.</b></p>
476 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
477 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
478 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.draw.engine.Svg.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
479 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
480  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.draw.engine.Svg.html#mon" rel="Ext.draw.engine.Svg#mon" class="docClass">mon</a> method.</p>
481 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.draw.engine.Svg.html#mon" rel="Ext.draw.engine.Svg#mon" class="docClass">mon</a> method.</p>
482 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
483 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
484 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
485 is the handler function.</p>
486 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
487 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
488 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
489 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.draw.engine.Svg.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
490 If events were suspended using the queueSuspended parameter, then all
491 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.draw.engine.Svg.html#suspendEvents" rel="Ext.draw.engine.Svg#suspendEvents" class="docClass">suspendEvents</a>)
492 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
493 events fired during event suspension will be sent to any listeners now.</p>
494 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
495 </li></ul></div></div></div><div id="method-setSize" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-setSize" rel="method-setSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.draw.Surface.html" class="definedIn docClass">Ext.draw.Surface</a><br/><a href="../source/Surface.html#Ext-draw.Surface-method-setSize" class="viewSource">view source</a></div><a name="setSize"></a><a name="method-setSize"></a><a href="Ext.draw.engine.Svg.html#" rel="method-setSize" class="cls expand">setSize</a>(
496 <span class="pre">Number w, Number h</span>)
497  : void</div><div class="description"><div class="short">Sets the size of the surface. Accomodates the background (if any) to fit the new size too.
498
499 For example:
500
501  drawCompon...</div><div class="long"><p>Sets the size of the surface. Accomodates the background (if any) to fit the new size too.</p>
502
503 <p>For example:</p>
504
505 <pre><code> drawComponent.surface.setSize(500, 500);
506 </code></pre>
507
508 <p>This method is generally called when also setting the size of the draw Component.</p>
509 <h3 class="pa">Parameters</h3><ul><li><span class="pre">w</span> : Number<div class="sub-desc"><p>The new width of the canvas.</p>
510 </div></li><li><span class="pre">h</span> : Number<div class="sub-desc"><p>The new height of the canvas.</p>
511 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
512 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.draw.engine.Svg.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
513 <span class="pre">Boolean queueSuspended</span>)
514  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.draw.engine.Svg.html#resumeEvents" rel="Ext.draw.engine.Svg#resumeEvents" class="docClass">resumeEvents</a>)</p>
515 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.draw.engine.Svg.html#resumeEvents" rel="Ext.draw.engine.Svg#resumeEvents" class="docClass">resumeEvents</a>)</p>
516 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
517 after the <a href="Ext.draw.engine.Svg.html#resumeEvents" rel="Ext.draw.engine.Svg#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
518 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
519 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.draw.engine.Svg.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.draw.engine.Svg.html#" rel="method-un" class="cls expand">un</a>(
520 <span class="pre">String eventName, Function handler, [Object scope]</span>)
521  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.draw.engine.Svg.html#removeListener" rel="Ext.draw.engine.Svg#removeListener" class="docClass">removeListener</a>.)</p>
522 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.draw.engine.Svg.html#removeListener" rel="Ext.draw.engine.Svg#removeListener" class="docClass">removeListener</a>.)</p>
523 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
524 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.draw.engine.Svg.html#addListener" rel="Ext.draw.engine.Svg#addListener" class="docClass">addListener</a> call.</b></p>
525 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
526 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
527 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>