Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.Array.js
1 Ext.data.JsonP.Ext_Array({
2   "tagname": "class",
3   "name": "Ext.Array",
4   "doc": "<p>A set of useful static methods to deal with arrays; provide missing methods for older browsers.</p>\n",
5   "extends": null,
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": "Jacky Nguyen <jacky@sencha.com>",
14   "docauthor": "Jacky Nguyen <jacky@sencha.com>",
15   "singleton": true,
16   "private": false,
17   "cfg": [
18
19   ],
20   "method": [
21     {
22       "tagname": "method",
23       "name": "clean",
24       "member": "Ext.Array",
25       "doc": "<p>Filter through an array and remove empty item as defined in <a href=\"#/api/Ext-method-isEmpty\" rel=\"Ext-method-isEmpty\" class=\"docClass\">Ext.isEmpty</a></p>\n\n<p>@see Ext.Array.filter</p>\n",
26       "params": [
27         {
28           "type": "Array",
29           "name": "array",
30           "doc": "\n",
31           "optional": false
32         }
33       ],
34       "return": {
35         "type": "Array",
36         "doc": "<p>results</p>\n"
37       },
38       "private": false,
39       "static": false,
40       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
41       "linenr": 344,
42       "html_filename": "Array2.html",
43       "href": "Array2.html#Ext-Array-method-clean",
44       "shortDoc": "<p>Filter through an array and remove empty item as defined in <a href=\"#/api/Ext-method-isEmpty\" rel=\"Ext-method-isEmpty\" class=\"docClass\">Ext.isEmpty</a></p>\n\n<p>@see Ext.Array.filter</p>\n"
45     },
46     {
47       "tagname": "method",
48       "name": "clone",
49       "member": "Ext.Array",
50       "doc": "<p>Clone a flat array without referencing the previous one. Note that this is different\nfrom Ext.clone since it doesn't handle recursive cloning. It's simply a convenient, easy-to-remember method\nfor Array.prototype.slice.call(array)</p>\n",
51       "params": [
52         {
53           "type": "Array",
54           "name": "array",
55           "doc": "<p>The array</p>\n",
56           "optional": false
57         }
58       ],
59       "return": {
60         "type": "Array",
61         "doc": "<p>The clone array</p>\n"
62       },
63       "private": false,
64       "static": false,
65       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
66       "linenr": 477,
67       "html_filename": "Array2.html",
68       "href": "Array2.html#Ext-Array-method-clone",
69       "shortDoc": "Clone a flat array without referencing the previous one. Note that this is different\nfrom Ext.clone since it doesn't ..."
70     },
71     {
72       "tagname": "method",
73       "name": "contains",
74       "member": "Ext.Array",
75       "doc": "<p>Checks whether or not the given <code>array</code> contains the specified <code>item</code></p>\n",
76       "params": [
77         {
78           "type": "Array",
79           "name": "array",
80           "doc": "<p>The array to check</p>\n",
81           "optional": false
82         },
83         {
84           "type": "Mixed",
85           "name": "item",
86           "doc": "<p>The item to look for</p>\n",
87           "optional": false
88         }
89       ],
90       "return": {
91         "type": "Boolean",
92         "doc": "<p>True if the array contains the item, false otherwise</p>\n"
93       },
94       "private": false,
95       "static": false,
96       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
97       "linenr": 161,
98       "html_filename": "Array2.html",
99       "href": "Array2.html#Ext-Array-method-contains",
100       "shortDoc": "<p>Checks whether or not the given <code>array</code> contains the specified <code>item</code></p>\n"
101     },
102     {
103       "tagname": "method",
104       "name": "difference",
105       "member": "Ext.Array",
106       "doc": "<p>Perform a set difference A-B by subtracting all items in array B from array A.</p>\n",
107       "params": [
108         {
109           "type": "Array",
110           "name": "array",
111           "doc": "<p>A</p>\n",
112           "optional": false
113         },
114         {
115           "type": "Array",
116           "name": "array",
117           "doc": "<p>B</p>\n",
118           "optional": false
119         }
120       ],
121       "return": {
122         "type": "Array",
123         "doc": "<p>difference</p>\n"
124       },
125       "private": false,
126       "static": false,
127       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
128       "linenr": 556,
129       "html_filename": "Array2.html",
130       "href": "Array2.html#Ext-Array-method-difference",
131       "shortDoc": "<p>Perform a set difference A-B by subtracting all items in array B from array A.</p>\n"
132     },
133     {
134       "tagname": "method",
135       "name": "each",
136       "member": "Ext.Array",
137       "doc": "<p>Iterates an array or an iterable value and invoke the given callback function for each item.</p>\n\n<pre><code>var countries = ['Vietnam', 'Singapore', 'United States', 'Russia'];\n\nExt.Array.each(countries, function(name, index, countriesItSelf) {\n    console.log(name);\n});\n\nvar sum = function() {\n    var sum = 0;\n\n    Ext.Array.each(arguments, function(value) {\n        sum += value;\n    });\n\n    return sum;\n};\n\nsum(1, 2, 3); // returns 6\n</code></pre>\n\n<p>The iteration can be stopped by returning false in the function callback.</p>\n\n<pre><code>Ext.Array.each(countries, function(name, index, countriesItSelf) {\n    if (name === 'Singapore') {\n        return false; // break here\n    }\n});\n</code></pre>\n",
138       "params": [
139         {
140           "type": "Array/NodeList/Mixed",
141           "name": "iterable",
142           "doc": "<p>The value to be iterated. If this\nargument is not iterable, the callback function is called once.</p>\n",
143           "optional": false
144         },
145         {
146           "type": "Function",
147           "name": "fn",
148           "doc": "<p>The callback function. If it returns false, the iteration stops and this method returns\nthe current <code>index</code>. Arguments passed to this callback function are:</p>\n\n<ul>\n<li><code>item</code>: {Mixed} The item at the current <code>index</code> in the passed <code>array</code></li>\n<li><code>index</code>: {Number} The current <code>index</code> within the <code>array</code></li>\n<li><code>allItems</code>: {Array/NodeList/Mixed} The <code>array</code> passed as the first argument to <code>Ext.Array.each</code></li>\n</ul>\n\n",
149           "optional": false
150         },
151         {
152           "type": "Object",
153           "name": "scope",
154           "doc": "<p>(Optional) The scope (<code>this</code> reference) in which the specified function is executed.</p>\n",
155           "optional": false
156         },
157         {
158           "type": "Boolean",
159           "name": "reverse",
160           "doc": "<p>(Optional) Reverse the iteration order (loop from the end to the beginning)\nDefaults false</p>\n",
161           "optional": false
162         }
163       ],
164       "return": {
165         "type": "Boolean",
166         "doc": "<p>See description for the <code>fn</code> parameter.</p>\n"
167       },
168       "private": false,
169       "static": false,
170       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
171       "linenr": 37,
172       "html_filename": "Array2.html",
173       "href": "Array2.html#Ext-Array-method-each",
174       "shortDoc": "Iterates an array or an iterable value and invoke the given callback function for each item.\n\nvar countries = ['Vietn..."
175     },
176     {
177       "tagname": "method",
178       "name": "every",
179       "member": "Ext.Array",
180       "doc": "<p>Executes the specified function for each array element until the function returns a falsy value.\nIf such an item is found, the function will return false immediately.\nOtherwise, it will return true.</p>\n",
181       "params": [
182         {
183           "type": "Array",
184           "name": "array",
185           "doc": "\n",
186           "optional": false
187         },
188         {
189           "type": "Function",
190           "name": "fn",
191           "doc": "<p>Callback function for each item</p>\n",
192           "optional": false
193         },
194         {
195           "type": "Object",
196           "name": "scope",
197           "doc": "<p>Callback function scope</p>\n",
198           "optional": false
199         }
200       ],
201       "return": {
202         "type": "Boolean",
203         "doc": "<p>True if no false value is returned by the callback function.</p>\n"
204       },
205       "private": false,
206       "static": false,
207       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
208       "linenr": 281,
209       "html_filename": "Array2.html",
210       "href": "Array2.html#Ext-Array-method-every",
211       "shortDoc": "Executes the specified function for each array element until the function returns a falsy value.\nIf such an item is f..."
212     },
213     {
214       "tagname": "method",
215       "name": "filter",
216       "member": "Ext.Array",
217       "doc": "<p>Creates a new array with all of the elements of this array for which\nthe provided filtering function returns true.</p>\n",
218       "params": [
219         {
220           "type": "Array",
221           "name": "array",
222           "doc": "\n",
223           "optional": false
224         },
225         {
226           "type": "Function",
227           "name": "fn",
228           "doc": "<p>Callback function for each item</p>\n",
229           "optional": false
230         },
231         {
232           "type": "Object",
233           "name": "scope",
234           "doc": "<p>Callback function scope</p>\n",
235           "optional": false
236         }
237       ],
238       "return": {
239         "type": "Array",
240         "doc": "<p>results</p>\n"
241       },
242       "private": false,
243       "static": false,
244       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
245       "linenr": 391,
246       "html_filename": "Array2.html",
247       "href": "Array2.html#Ext-Array-method-filter",
248       "shortDoc": "<p>Creates a new array with all of the elements of this array for which\nthe provided filtering function returns true.</p>\n"
249     },
250     {
251       "tagname": "method",
252       "name": "flatten",
253       "member": "Ext.Array",
254       "doc": "<p>Recursively flattens into 1-d Array. Injects Arrays inline.</p>\n",
255       "params": [
256         {
257           "type": "Array",
258           "name": "array",
259           "doc": "<p>The array to flatten</p>\n",
260           "optional": false
261         }
262       ],
263       "return": {
264         "type": "Array",
265         "doc": "<p>The new, flattened array.</p>\n"
266       },
267       "private": false,
268       "static": false,
269       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
270       "linenr": 625,
271       "html_filename": "Array2.html",
272       "href": "Array2.html#Ext-Array-method-flatten",
273       "shortDoc": "<p>Recursively flattens into 1-d Array. Injects Arrays inline.</p>\n"
274     },
275     {
276       "tagname": "method",
277       "name": "forEach",
278       "member": "Ext.Array",
279       "doc": "<p>Iterates an array and invoke the given callback function for each item. Note that this will simply\ndelegate to the native Array.prototype.forEach method if supported.\nIt doesn't support stopping the iteration by returning false in the callback function like\n<a href=\"#/api/Ext.Array-method-each\" rel=\"Ext.Array-method-each\" class=\"docClass\">each</a>. However, performance could be much better in modern browsers comparing with\n<a href=\"#/api/Ext.Array-method-each\" rel=\"Ext.Array-method-each\" class=\"docClass\">each</a></p>\n",
280       "params": [
281         {
282           "type": "Array",
283           "name": "array",
284           "doc": "<p>The array to iterate</p>\n",
285           "optional": false
286         },
287         {
288           "type": "Function",
289           "name": "fn",
290           "doc": "<p>The function callback, to be invoked these arguments:</p>\n\n<ul>\n<li><code>item</code>: {Mixed} The item at the current <code>index</code> in the passed <code>array</code></li>\n<li><code>index</code>: {Number} The current <code>index</code> within the <code>array</code></li>\n<li><code>allItems</code>: {Array} The <code>array</code> itself which was passed as the first argument</li>\n</ul>\n\n",
291           "optional": false
292         },
293         {
294           "type": "Object",
295           "name": "scope",
296           "doc": "<p>(Optional) The execution scope (<code>this</code>) in which the specified function is executed.</p>\n",
297           "optional": false
298         }
299       ],
300       "return": {
301         "type": "void",
302         "doc": "\n"
303       },
304       "private": false,
305       "static": false,
306       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
307       "linenr": 105,
308       "html_filename": "Array2.html",
309       "href": "Array2.html#Ext-Array-method-forEach",
310       "shortDoc": "Iterates an array and invoke the given callback function for each item. Note that this will simply\ndelegate to the na..."
311     },
312     {
313       "tagname": "method",
314       "name": "from",
315       "member": "Ext.Array",
316       "doc": "<p>Converts a value to an array if it's not already an array; returns:</p>\n\n<ul>\n<li>An empty array if given value is <code>undefined</code> or <code>null</code></li>\n<li>Itself if given value is already an array</li>\n<li>An array copy if given value is <a href=\"#/api/Ext-method-isIterable\" rel=\"Ext-method-isIterable\" class=\"docClass\">iterable</a> (arguments, NodeList and alike)</li>\n<li>An array with one item which is the given value, otherwise</li>\n</ul>\n\n",
317       "params": [
318         {
319           "type": "Array/Mixed",
320           "name": "value",
321           "doc": "<p>The value to convert to an array if it's not already is an array</p>\n",
322           "optional": false
323         },
324         {
325           "type": "Boolean",
326           "name": "newReference",
327           "doc": "<p>(Optional) newReference True to clone the given array and return a new reference if necessary,\ndefaults to false</p>\n",
328           "optional": false
329         }
330       ],
331       "return": {
332         "type": "Array",
333         "doc": "<p>array</p>\n"
334       },
335       "private": false,
336       "static": false,
337       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
338       "linenr": 417,
339       "html_filename": "Array2.html",
340       "href": "Array2.html#Ext-Array-method-from",
341       "shortDoc": "Converts a value to an array if it's not already an array; returns:\n\n\nAn empty array if given value is undefined or n..."
342     },
343     {
344       "tagname": "method",
345       "name": "include",
346       "member": "Ext.Array",
347       "doc": "<p>Push an item into the array only if the array doesn't contain it yet</p>\n",
348       "params": [
349         {
350           "type": "Array",
351           "name": "array",
352           "doc": "<p>The array</p>\n",
353           "optional": false
354         },
355         {
356           "type": "Mixed",
357           "name": "item",
358           "doc": "<p>The item to include</p>\n",
359           "optional": false
360         }
361       ],
362       "return": {
363         "type": "Array",
364         "doc": "<p>The passed array itself</p>\n"
365       },
366       "private": false,
367       "static": false,
368       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
369       "linenr": 464,
370       "html_filename": "Array2.html",
371       "href": "Array2.html#Ext-Array-method-include",
372       "shortDoc": "<p>Push an item into the array only if the array doesn't contain it yet</p>\n"
373     },
374     {
375       "tagname": "method",
376       "name": "indexOf",
377       "member": "Ext.Array",
378       "doc": "<p>Get the index of the provided <code>item</code> in the given <code>array</code>, a supplement for the\nmissing arrayPrototype.indexOf in Internet Explorer.</p>\n",
379       "params": [
380         {
381           "type": "Array",
382           "name": "array",
383           "doc": "<p>The array to check</p>\n",
384           "optional": false
385         },
386         {
387           "type": "Mixed",
388           "name": "item",
389           "doc": "<p>The item to look for</p>\n",
390           "optional": false
391         },
392         {
393           "type": "Number",
394           "name": "from",
395           "doc": "<p>(Optional) The index at which to begin the search</p>\n",
396           "optional": false
397         }
398       ],
399       "return": {
400         "type": "Number",
401         "doc": "<p>The index of item in the array (or -1 if it is not found)</p>\n"
402       },
403       "private": false,
404       "static": false,
405       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
406       "linenr": 135,
407       "html_filename": "Array2.html",
408       "href": "Array2.html#Ext-Array-method-indexOf",
409       "shortDoc": "Get the index of the provided item in the given array, a supplement for the\nmissing arrayPrototype.indexOf in Interne..."
410     },
411     {
412       "tagname": "method",
413       "name": "intersect",
414       "member": "Ext.Array",
415       "doc": "<p>Merge multiple arrays into one with unique items that exist in all of the arrays.</p>\n",
416       "params": [
417         {
418           "type": "Array",
419           "name": "array",
420           "doc": "<p>,...</p>\n",
421           "optional": false
422         }
423       ],
424       "return": {
425         "type": "Array",
426         "doc": "<p>intersect</p>\n"
427       },
428       "private": false,
429       "static": false,
430       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
431       "linenr": 507,
432       "html_filename": "Array2.html",
433       "href": "Array2.html#Ext-Array-method-intersect",
434       "shortDoc": "<p>Merge multiple arrays into one with unique items that exist in all of the arrays.</p>\n"
435     },
436     {
437       "tagname": "method",
438       "name": "map",
439       "member": "Ext.Array",
440       "doc": "<p>Creates a new array with the results of calling a provided function on every element in this array.</p>\n",
441       "params": [
442         {
443           "type": "Array",
444           "name": "array",
445           "doc": "\n",
446           "optional": false
447         },
448         {
449           "type": "Function",
450           "name": "fn",
451           "doc": "<p>Callback function for each item</p>\n",
452           "optional": false
453         },
454         {
455           "type": "Object",
456           "name": "scope",
457           "doc": "<p>Callback function scope</p>\n",
458           "optional": false
459         }
460       ],
461       "return": {
462         "type": "Array",
463         "doc": "<p>results</p>\n"
464       },
465       "private": false,
466       "static": false,
467       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
468       "linenr": 258,
469       "html_filename": "Array2.html",
470       "href": "Array2.html#Ext-Array-method-map",
471       "shortDoc": "<p>Creates a new array with the results of calling a provided function on every element in this array.</p>\n"
472     },
473     {
474       "tagname": "method",
475       "name": "max",
476       "member": "Ext.Array",
477       "doc": "<p>Returns the maximum value in the Array</p>\n",
478       "params": [
479         {
480           "type": "Array|NodeList",
481           "name": "array",
482           "doc": "<p>The Array from which to select the maximum value.</p>\n",
483           "optional": false
484         },
485         {
486           "type": "Function",
487           "name": "comparisonFn",
488           "doc": "<p>(optional) a function to perform the comparision which determines maximization.</p>\n\n<pre><code>              If omitted the \"&gt;\" operator will be used. Note: gt = 1; eq = 0; lt = -1\n</code></pre>\n",
489           "optional": true
490         }
491       ],
492       "return": {
493         "type": "Mixed",
494         "doc": "<p>maxValue The maximum value</p>\n"
495       },
496       "private": false,
497       "static": false,
498       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
499       "linenr": 681,
500       "html_filename": "Array2.html",
501       "href": "Array2.html#Ext-Array-method-max",
502       "shortDoc": "<p>Returns the maximum value in the Array</p>\n"
503     },
504     {
505       "tagname": "method",
506       "name": "mean",
507       "member": "Ext.Array",
508       "doc": "<p>Calculates the mean of all items in the array</p>\n",
509       "params": [
510         {
511           "type": "Array",
512           "name": "array",
513           "doc": "<p>The Array to calculate the mean value of.</p>\n",
514           "optional": false
515         }
516       ],
517       "return": {
518         "type": "Number",
519         "doc": "<p>The mean.</p>\n"
520       },
521       "private": false,
522       "static": false,
523       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
524       "linenr": 710,
525       "html_filename": "Array2.html",
526       "href": "Array2.html#Ext-Array-method-mean",
527       "shortDoc": "<p>Calculates the mean of all items in the array</p>\n"
528     },
529     {
530       "tagname": "method",
531       "name": "merge",
532       "member": "Ext.Array",
533       "doc": "<p>Merge multiple arrays into one with unique items. Alias to <a href=\"#/api/Ext.Array-method-union\" rel=\"Ext.Array-method-union\" class=\"docClass\">union</a>.</p>\n",
534       "params": [
535         {
536           "type": "Array",
537           "name": "array",
538           "doc": "<p>,...</p>\n",
539           "optional": false
540         }
541       ],
542       "return": {
543         "type": "Array",
544         "doc": "<p>merged</p>\n"
545       },
546       "private": false,
547       "static": false,
548       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
549       "linenr": 489,
550       "html_filename": "Array2.html",
551       "href": "Array2.html#Ext-Array-method-merge",
552       "shortDoc": "<p>Merge multiple arrays into one with unique items. Alias to <a href=\"#/api/Ext.Array-method-union\" rel=\"Ext.Array-method-union\" class=\"docClass\">union</a>.</p>\n"
553     },
554     {
555       "tagname": "method",
556       "name": "min",
557       "member": "Ext.Array",
558       "doc": "<p>Returns the minimum value in the Array.</p>\n",
559       "params": [
560         {
561           "type": "Array|NodeList",
562           "name": "array",
563           "doc": "<p>The Array from which to select the minimum value.</p>\n",
564           "optional": false
565         },
566         {
567           "type": "Function",
568           "name": "comparisonFn",
569           "doc": "<p>(optional) a function to perform the comparision which determines minimization.</p>\n\n<pre><code>              If omitted the \"&lt;\" operator will be used. Note: gt = 1; eq = 0; lt = -1\n</code></pre>\n",
570           "optional": true
571         }
572       ],
573       "return": {
574         "type": "Mixed",
575         "doc": "<p>minValue The minimum value</p>\n"
576       },
577       "private": false,
578       "static": false,
579       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
580       "linenr": 652,
581       "html_filename": "Array2.html",
582       "href": "Array2.html#Ext-Array-method-min",
583       "shortDoc": "<p>Returns the minimum value in the Array.</p>\n"
584     },
585     {
586       "tagname": "method",
587       "name": "pluck",
588       "member": "Ext.Array",
589       "doc": "<p>Plucks the value of a property from each item in the Array. Example:</p>\n\n<pre><code>Ext.Array.pluck(Ext.query(\"p\"), \"className\"); // [el1.className, el2.className, ..., elN.className]\n</code></pre>\n",
590       "params": [
591         {
592           "type": "Array|NodeList",
593           "name": "array",
594           "doc": "<p>The Array of items to pluck the value from.</p>\n",
595           "optional": false
596         },
597         {
598           "type": "String",
599           "name": "propertyName",
600           "doc": "<p>The property name to pluck from each element.</p>\n",
601           "optional": false
602         }
603       ],
604       "return": {
605         "type": "Array",
606         "doc": "<p>The value from each item in the Array.</p>\n"
607       },
608       "private": false,
609       "static": false,
610       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
611       "linenr": 236,
612       "html_filename": "Array2.html",
613       "href": "Array2.html#Ext-Array-method-pluck",
614       "shortDoc": "Plucks the value of a property from each item in the Array. Example:\n\nExt.Array.pluck(Ext.query(\"p\"), \"className\"); /..."
615     },
616     {
617       "tagname": "method",
618       "name": "remove",
619       "member": "Ext.Array",
620       "doc": "<p>Removes the specified item from the array if it exists</p>\n",
621       "params": [
622         {
623           "type": "Array",
624           "name": "array",
625           "doc": "<p>The array</p>\n",
626           "optional": false
627         },
628         {
629           "type": "Mixed",
630           "name": "item",
631           "doc": "<p>The item to remove</p>\n",
632           "optional": false
633         }
634       ],
635       "return": {
636         "type": "Array",
637         "doc": "<p>The passed array itself</p>\n"
638       },
639       "private": false,
640       "static": false,
641       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
642       "linenr": 447,
643       "html_filename": "Array2.html",
644       "href": "Array2.html#Ext-Array-method-remove",
645       "shortDoc": "<p>Removes the specified item from the array if it exists</p>\n"
646     },
647     {
648       "tagname": "method",
649       "name": "some",
650       "member": "Ext.Array",
651       "doc": "<p>Executes the specified function for each array element until the function returns a truthy value.\nIf such an item is found, the function will return true immediately. Otherwise, it will return false.</p>\n",
652       "params": [
653         {
654           "type": "Array",
655           "name": "array",
656           "doc": "\n",
657           "optional": false
658         },
659         {
660           "type": "Function",
661           "name": "fn",
662           "doc": "<p>Callback function for each item</p>\n",
663           "optional": false
664         },
665         {
666           "type": "Object",
667           "name": "scope",
668           "doc": "<p>Callback function scope</p>\n",
669           "optional": false
670         }
671       ],
672       "return": {
673         "type": "Boolean",
674         "doc": "<p>True if the callback function returns a truthy value.</p>\n"
675       },
676       "private": false,
677       "static": false,
678       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
679       "linenr": 313,
680       "html_filename": "Array2.html",
681       "href": "Array2.html#Ext-Array-method-some",
682       "shortDoc": "Executes the specified function for each array element until the function returns a truthy value.\nIf such an item is ..."
683     },
684     {
685       "tagname": "method",
686       "name": "sort",
687       "member": "Ext.Array",
688       "doc": "<p>Sorts the elements of an Array.\nBy default, this method sorts the elements alphabetically and ascending.</p>\n",
689       "params": [
690         {
691           "type": "Array",
692           "name": "array",
693           "doc": "<p>The array to sort.</p>\n",
694           "optional": false
695         },
696         {
697           "type": "Function",
698           "name": "sortFn",
699           "doc": "<p>(optional) The comparison function.</p>\n",
700           "optional": true
701         }
702       ],
703       "return": {
704         "type": "Array",
705         "doc": "<p>The sorted array.</p>\n"
706       },
707       "private": false,
708       "static": false,
709       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
710       "linenr": 581,
711       "html_filename": "Array2.html",
712       "href": "Array2.html#Ext-Array-method-sort",
713       "shortDoc": "<p>Sorts the elements of an Array.\nBy default, this method sorts the elements alphabetically and ascending.</p>\n"
714     },
715     {
716       "tagname": "method",
717       "name": "sum",
718       "member": "Ext.Array",
719       "doc": "<p>Calculates the sum of all items in the given array</p>\n",
720       "params": [
721         {
722           "type": "Array",
723           "name": "array",
724           "doc": "<p>The Array to calculate the sum value of.</p>\n",
725           "optional": false
726         }
727       ],
728       "return": {
729         "type": "Number",
730         "doc": "<p>The sum.</p>\n"
731       },
732       "private": false,
733       "static": false,
734       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
735       "linenr": 719,
736       "html_filename": "Array2.html",
737       "href": "Array2.html#Ext-Array-method-sum",
738       "shortDoc": "<p>Calculates the sum of all items in the given array</p>\n"
739     },
740     {
741       "tagname": "method",
742       "name": "toArray",
743       "member": "Ext.Array",
744       "doc": "<p>Converts any iterable (numeric indices and a length property) into a true array.</p>\n\n<p>function test() {</p>\n\n<pre><code>var args = Ext.Array.toArray(arguments),\n    fromSecondToLastArgs = Ext.Array.toArray(arguments, 1);\n\nalert(args.join(' '));\nalert(fromSecondToLastArgs.join(' '));\n</code></pre>\n\n<p>}</p>\n\n<p>test('just', 'testing', 'here'); // alerts 'just testing here';</p>\n\n<pre><code>                             // alerts 'testing here';\n</code></pre>\n\n<p>Ext.Array.toArray(document.getElementsByTagName('div')); // will convert the NodeList into an array\nExt.Array.toArray('splitted'); // returns ['s', 'p', 'l', 'i', 't', 't', 'e', 'd']\nExt.Array.toArray('splitted', 0, 3); // returns ['s', 'p', 'l', 'i']</p>\n",
745       "params": [
746         {
747           "type": "Mixed",
748           "name": "iterable",
749           "doc": "<p>the iterable object to be turned into a true Array.</p>\n",
750           "optional": false
751         },
752         {
753           "type": "Number",
754           "name": "start",
755           "doc": "<p>(Optional) a zero-based index that specifies the start of extraction. Defaults to 0</p>\n",
756           "optional": false
757         },
758         {
759           "type": "Number",
760           "name": "end",
761           "doc": "<p>(Optional) a zero-based index that specifies the end of extraction. Defaults to the last\nindex of the iterable value</p>\n",
762           "optional": false
763         }
764       ],
765       "return": {
766         "type": "Array",
767         "doc": "<p>array</p>\n"
768       },
769       "private": false,
770       "static": false,
771       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
772       "linenr": 185,
773       "html_filename": "Array2.html",
774       "href": "Array2.html#Ext-Array-method-toArray",
775       "shortDoc": "Converts any iterable (numeric indices and a length property) into a true array.\n\nfunction test() {\n\nvar args = Ext.A..."
776     },
777     {
778       "tagname": "method",
779       "name": "union",
780       "member": "Ext.Array",
781       "doc": "<p>Alias to <a href=\"#/api/Ext.Array-method-merge\" rel=\"Ext.Array-method-merge\" class=\"docClass\">merge</a>.</p>\n",
782       "params": [
783
784       ],
785       "return": {
786         "type": "void",
787         "doc": "\n"
788       },
789       "private": false,
790       "static": false,
791       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
792       "linenr": 746,
793       "html_filename": "Array2.html",
794       "href": "Array2.html#Ext-Array-method-union",
795       "shortDoc": "<p>Alias to <a href=\"#/api/Ext.Array-method-merge\" rel=\"Ext.Array-method-merge\" class=\"docClass\">merge</a>.</p>\n"
796     },
797     {
798       "tagname": "method",
799       "name": "unique",
800       "member": "Ext.Array",
801       "doc": "<p>Returns a new array with unique items</p>\n",
802       "params": [
803         {
804           "type": "Array",
805           "name": "array",
806           "doc": "\n",
807           "optional": false
808         }
809       ],
810       "return": {
811         "type": "Array",
812         "doc": "<p>results</p>\n"
813       },
814       "private": false,
815       "static": false,
816       "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
817       "linenr": 368,
818       "html_filename": "Array2.html",
819       "href": "Array2.html#Ext-Array-method-unique",
820       "shortDoc": "<p>Returns a new array with unique items</p>\n"
821     }
822   ],
823   "property": [
824
825   ],
826   "event": [
827
828   ],
829   "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Array.js",
830   "linenr": 1,
831   "html_filename": "Array2.html",
832   "href": "Array2.html#Ext-Array",
833   "cssVar": [
834
835   ],
836   "cssMixin": [
837
838   ],
839   "component": false,
840   "superclasses": [
841
842   ],
843   "subclasses": [
844
845   ],
846   "mixedInto": [
847
848   ],
849   "allMixins": [
850
851   ]
852 });