4 A collection of Array methods and functions.
11 Function: Array.each {#Array:Array-each}
12 ----------------------------------
14 Used to iterate through arrays, or iterables that are not regular arrays, such as built in getElementsByTagName calls or arguments of a function.
18 Array.each(iterable, fn[, bind]);
22 1. iterable - (*array*) The array to iterate through.
23 2. fn - (*function*) The function to test for each element.
24 3. bind - (*object*, optional) The object to use as 'this' within the function. For more information see [Function:bind][].
30 fn(item, index, object)
34 1. item - (*mixed*) The current item in the array.
35 2. index - (*number*) The current item's index in the array. In the case of an object, it is passed the key of that item rather than the index.
36 3. object - (*mixed*) The actual array/object.
40 Array.each(['Sun', 'Mon', 'Tue'], function(day, index){
41 alert('name:' + day + ', index: ' + index);
42 }); // alerts 'name: Sun, index: 0', 'name: Mon, index: 1', etc.
46 - [Array:each](#Array:each)
50 This is an array-specific equivalent of *$each* from MooTools 1.2.
54 Function: Array.clone {#Array:Array-clone}
55 ------------------------------------
57 Returns a copy of the passed array.
61 var clone = Array.clone(myArray);
65 1. myArray - (*array*) The array you wish to copy.
69 * (*array*) a copy of the passed array.
73 var myArray = ['red', 'blue', 'green'];
74 var otherArray = Array.clone(myArray);
76 var myArray[0] = 'yellow';
78 alert(myArray[0]); // alerts 'yellow'
79 alert(otherArray[0]) // alerts 'red'
83 This is an array-specific equivalent of *$unlink* from MooTools 1.2.
87 Function: Array.from {#Array:Array-from}
88 ----------------------------------
90 Converts the argument passed in to an array if it is defined and not already an array.
94 var splatted = Array.from(obj);
98 1. obj - (*mixed*) Any type of variable.
102 * (*array*) If the variable passed in is an array, returns the array. Otherwise, returns an array with the only element being the variable passed in.
106 Array.from('hello'); // returns ['hello'].
107 Array.from(['a', 'b', 'c']); // returns ['a', 'b', 'c'].
111 This is equivalent to *$splat* from MooTools 1.2, with the exception of Array-like Objects such as NodeList or FileList which `Array.from` does transform in
112 Arrays and `$splat` not.
116 Array method: each {#Array:each}
117 ---------------------------------
119 Calls a function for each element in the array.
123 myArray.each(fn[, bind]);
127 1. fn - (*function*) The function which should be executed on each item in the array. This function is passed the item and its index in the array.
128 2. bind - (*object*, optional) The object to be used as 'this' in the function. For more information see [Function:bind][].
134 fn(item, index, array)
138 1. item - (*mixed*) The current item in the array.
139 2. index - (*number*) The current item's index in the array.
140 3. array - (*array*) The actual array.
144 //Alerts "0 = apple", "1 = banana", and so on:
145 ['apple', 'banana', 'lemon'].each(function(item, index){
146 alert(index + " = " + item);
147 }); //The optional second argument for binding isn't used here.
152 - [Array.each](#Array:Array-each)
153 - [MDN Array:forEach][]
157 - This method is only available for browsers without native [MDN Array:forEach][] support.
164 Array method: invoke {#Array:invoke}
165 --------------------------
167 Returns an array with the named method applied to the array's contents.
171 var arr = myArray.invoke(method[, arg, arg, arg ...])
175 1. method - (*string*) The method to apply to each item in the array.
176 2. arg - (*mixed*) Any number of arguments to pass to the named method.
180 * (*array*) A new array containing the results of the applied method.
184 var foo = [4, 8, 15, 16, 23, 42];
185 var bar = foo.invoke('limit', 10, 30); //bar is now [10, 10, 15, 16, 23, 30]
189 The method that is invoked is a method of each of the items.
190 If the method does not exist, then an error will be thrown. For example:
192 [0, false, 'string'].invoke('limit', 0, 10); // throws an error!
194 Array method: every {#Array:every}
195 ----------------------------
197 Returns true if every element in the array satisfies the provided testing function.
198 This method is provided only for browsers without native [Array:every][] support.
202 var allPassed = myArray.every(fn[, bind]);
206 1. fn - (*function*) The function to test for each element.
207 2. bind - (*object*, optional) The object to use as 'this' in the function. For more information see [Function:bind][].
213 fn(item, index, array)
217 1. item - (*mixed*) The current item in the array.
218 2. index - (*number*) The current item's index in the array.
219 3. array - (*array*) The actual array.
223 * (*boolean*) If every element in the array satisfies the provided testing function, returns true. Otherwise, returns false.
227 var areAllBigEnough = [10, 4, 25, 100].every(function(item, index){
229 }); // areAllBigEnough = false
234 - [MDN Array:every][]
238 Array method: filter {#Array:filter}
239 ------------------------------
241 Creates a new array with all of the elements of the array for which the provided filtering function returns true.
242 This method is provided only for browsers without native [Array:filter][] support.
246 var filteredArray = myArray.filter(fn[, bind]);
250 1. fn - (*function*) The function to test each element of the array. This function is passed the item and its index in the array.
251 2. bind - (*object*, optional) The object to use as 'this' in the function. For more information see [Function:bind][].
257 fn(item, index, array)
261 1. item - (*mixed*) The current item in the array.
262 2. index - (*number*) The current item's index in the array.
263 3. array - (*array*) The actual array.
267 * (*array*) The new filtered array.
271 var biggerThanTwenty = [10, 3, 25, 100].filter(function(item, index){
273 }); // biggerThanTwenty = [25, 100]
277 - [MDN Array:filter][]
281 Array method: clean {#Array:clean}
282 ----------------------------
284 Creates a new array with all of the elements of the array which are defined (i.e. not null or undefined).
288 var cleanedArray = myArray.clean();
292 * (*array*) The new filtered array.
296 var myArray = [null, 1, 0, true, false, 'foo', undefined, ''];
297 myArray.clean() // returns [1, 0, true, false, 'foo', '']
301 Array method: indexOf {#Array:indexOf}
302 --------------------------------
304 Returns the index of the first element within the array equal to the specified value, or -1 if the value is not found.
305 This method is provided only for browsers without native [Array:indexOf][] support.
309 var index = myArray.indexOf(item[, from]);
313 * (*number*) The index of the first element within the array equal to the specified value. If not found, returns -1.
317 1. item - (*object*) The item to search for in the array.
318 2. from - (*number*, optional: defaults to 0) The index of the array at which to begin the search.
322 ['apple', 'lemon', 'banana'].indexOf('lemon'); // returns 1
323 ['apple', 'lemon'].indexOf('banana'); // returns -1
327 - [MDN Array:indexOf][]
331 Array method: map {#Array:map}
332 ------------------------
334 Creates a new array with the results of calling a provided function on every element in the array.
335 This method is provided only for browsers without native [Array:map][] support.
339 var mappedArray = myArray.map(fn[, bind]);
343 1. fn - (*function*) The function to produce an element of the new Array from an element of the current one.
344 2. bind - (*object*, optional) The object to use as 'this' in the function. For more information see [Function:bind][].
350 fn(item, index, array)
354 1. item - (*mixed*) The current item in the array.
355 2. index - (*number*) The current item's index in the array.
356 3. array - (*array*) The actual array.
360 * (*array*) The new mapped array.
364 var timesTwo = [1, 2, 3].map(function(item, index){
366 }); //timesTwo = [2, 4, 6];
374 Array method: some {#Array:some}
375 --------------------------
377 Returns true if at least one element in the array satisfies the provided testing function.
378 This method is provided only for browsers without native [Array:some][] support.
382 var somePassed = myArray.some(fn[, bind]);
386 * (*boolean*) If at least one element in the array satisfies the provided testing function returns true. Otherwise, returns false.
390 1. fn - (*function*) The function to test for each element. This function is passed the item and its index in the array.
391 2. bind - (*object*, optional) The object to use as 'this' in the function. For more information see [Function:bind][].
397 fn(item, index, array)
401 1. item - (*mixed*) The current item in the array.
402 2. index - (*number*) The current item's index in the array.
403 3. array - (*array*) The actual array.
407 var isAnyBigEnough = [10, 4, 25, 100].some(function(item, index){
409 }); // isAnyBigEnough = true
417 Array method: associate {#Array:associate}
418 ------------------------------------
420 Creates an object with key-value pairs based on the array of keywords passed in and the current content of the array.
424 var associated = myArray.associate(obj);
428 1. obj - (*array*) Its items will be used as the keys of the object that will be created.
432 * (*object*) The new associated object.
436 var animals = ['Cow', 'Pig', 'Dog', 'Cat'];
437 var sounds = ['Moo', 'Oink', 'Woof', 'Miao'];
438 sounds.associate(animals);
439 // returns {'Cow': 'Moo', 'Pig': 'Oink', 'Dog': 'Woof', 'Cat': 'Miao'}
443 Array method: link {#Array:link}
444 --------------------------
446 Accepts an object of key / function pairs to assign values.
450 var result = myArray.link(object);
454 1. object - (*object*) An object containing key / function pairs must be passed to be used as a template for associating values with the different keys.
458 * (*object*) The new associated object.
462 var el = document.createElement('div');
463 var arr2 = [100, 'Hello', {foo: 'bar'}, el, false];
465 myNumber: Type.isNumber,
466 myElement: Type.isElement,
467 myObject: Type.isObject,
468 myString: Type.isString,
469 myBoolean: function(obj){ return obj != null; }
471 // returns {myNumber: 100, myElement: el, myObject: {foo: 'bar'}, myString: 'Hello', myBoolean: false}
474 Array method: contains {#Array:contains}
475 ----------------------------------
477 Tests an array for the presence of an item.
481 var inArray = myArray.contains(item[, from]);
485 1. item - (*object*) The item to search for in the array.
486 2. from - (*number*, optional: defaults to 0) The index of the array at which to begin the search.
490 * (*boolean*) If the array contains the item specified, returns true. Otherwise, returns false.
494 ['a', 'b', 'c'].contains('a'); // returns true
495 ['a', 'b', 'c'].contains('d'); // returns false
499 - [MDN Array:indexOf][]
503 Array method: append {#Array:append}
504 ------------------------------
506 Appends the passed array to the end of the current array.
510 var myArray = myArray.append(otherArray);
514 1. otherArray - (*array*) The array containing values you wish to append.
518 * (*array*) The original array including the new values.
522 var myOtherArray = ['green', 'yellow'];
523 ['red', 'blue'].append(myOtherArray); // returns ['red', 'blue', 'green', 'yellow'];
525 [0, 1, 2].append([3, [4]]); // [0, 1, 2, 3, [4]]
529 This is an array-specific equivalent of *$extend* from MooTools 1.2.
533 Array method: getLast {#Array:getLast}
534 --------------------------------
536 Returns the last item from the array.
544 * (*mixed*) The last item in this array.
545 * (*null*) If this array is empty, returns null.
549 ['Cow', 'Pig', 'Dog', 'Cat'].getLast(); // returns 'Cat'
553 Array method: getRandom {#Array:getRandom}
554 ------------------------------------
556 Returns a random item from the array.
564 * (*mixed*) A random item from this array. If this array is empty, returns null.
568 ['Cow', 'Pig', 'Dog', 'Cat'].getRandom(); // returns one of the items
572 Array method: include {#Array:include}
573 --------------------------------
575 Pushes the passed element into the array if it's not already present (case and type sensitive).
579 myArray.include(item);
583 1. item - (*object*) The item that should be added to this array.
587 * (*array*) This array with the new item included.
591 ['Cow', 'Pig', 'Dog'].include('Cat'); // returns ['Cow', 'Pig', 'Dog', 'Cat']
592 ['Cow', 'Pig', 'Dog'].include('Dog'); // returns ['Cow', 'Pig', 'Dog']
596 If you want to push the passed element even if it's already present, use
597 the vanilla javascript:
601 Array method: combine {#Array:combine}
602 --------------------------------
604 Combines an array with all the items of another. Does not allow duplicates and is case and type sensitive.
608 myArray.combine(array);
612 1. array - (*array*) The array whose items should be combined into this array.
616 * (*array*) This array combined with the new items.
620 var animals = ['Cow', 'Pig', 'Dog'];
621 animals.combine(['Cat', 'Dog']); //animals = ['Cow', 'Pig', 'Dog', 'Cat'];
625 Array method: erase {#Array:erase}
626 ----------------------------
628 Removes all occurrences of an item from the array.
636 1. item - (*object*) The item to search for in the array.
640 * (*array*) This array with all occurrences of the item removed.
644 ['Cow', 'Pig', 'Dog', 'Cat', 'Dog'].erase('Dog') // returns ['Cow', 'Pig', 'Cat']
645 ['Cow', 'Pig', 'Dog'].erase('Cat') // returns ['Cow', 'Pig', 'Dog']
649 Array method: empty {#Array:empty}
650 ----------------------------
660 * (*array*) This array, emptied.
664 var myArray = ['old', 'data'];
665 myArray.empty(); //myArray is now []
668 Array method: flatten {#Array:flatten}
669 --------------------------------
671 Flattens a multidimensional array into a single array.
679 * (*array*) A new flat array.
683 var myArray = [1,2,3,[4,5, [6,7]], [[[8]]]];
684 var newArray = myArray.flatten(); //newArray is [1,2,3,4,5,6,7,8]
688 Array method: pick {#Array:pick}
689 --------------------------
690 Returns the first defined value of the array passed in, or null.
694 var picked = [var1, var2, var3].pick();
698 * (*mixed*) The first variable that is defined.
699 * (*null*) If all variables passed in are `null` or `undefined`, returns `null`.
703 function say(infoMessage, errorMessage){
704 alert([errorMessage, infoMessage, 'There was no message supplied.'].pick());
706 //or more MooTools 1.2 style using Generics
707 Array.pick([errorMessage, infoMessage, 'There was no message supplied.']);
710 say(); // alerts 'There was no message supplied.'
711 say('This is an info message.'); // alerts 'This is an info message.'
712 say('This message will be ignored.', 'This is the error message.'); // alerts 'This is the error message.'
717 This is equivalent to *$pick* from MooTools 1.2.
721 Array method: hexToRgb {#Array:hexToRgb}
722 ----------------------------------
724 Converts an hexadecimal color value to RGB. Input array must be the following hexadecimal color format.
729 myArray.hexToRgb([array]);
733 1. array - (*boolean*, optional) If true is passed, will output an array (e.g. \[255, 51, 0\]) instead of a string (e.g. "rgb(255, 51, 0)").
737 * (*string*) A string representing the color in RGB.
738 * (*array*) If the array flag is set, an array will be returned instead.
742 ['11', '22', '33'].hexToRgb(); // returns 'rgb(17, 34, 51)'
743 ['11', '22', '33'].hexToRgb(true); // returns [17, 34, 51]
747 - [String:hexToRgb][]
751 Array method: rgbToHex {#Array:rgbToHex}
752 ----------------------------------
754 Converts an RGB color value to hexadecimal. Input array must be in one of the following RGB color formats.
755 \[255, 255, 255\], or \[255, 255, 255, 1\]
759 myArray.rgbToHex([array]);
763 1. array - (*boolean*, optional) If true is passed, will output an array (e.g. \['ff', '33', '00'\]) instead of a string (e.g. '#ff3300').
767 * (*string*) A string representing the color in hexadecimal, or 'transparent' string if the fourth value of rgba in the input array is 0 (rgba).
768 * (*array*) If the array flag is set, an array will be returned instead.
772 [17, 34, 51].rgbToHex(); // returns '#112233'
773 [17, 34, 51].rgbToHex(true); // returns ['11', '22', '33']
774 [17, 34, 51, 0].rgbToHex(); // returns 'transparent'
778 - [String:rgbToHex][]
782 [Function:bind]: /core/Types/Function/#Function:bind
783 [String:hexToRgb]: /core/Types/String/#String:hexToRgb
784 [String:rgbToHex]: /core/Types/String/#String:rgbToHex
785 [MDN Array]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array
786 [MDN Array:every]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/every
787 [MDN Array:filter]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/filter
788 [MDN Array:indexOf]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/indexOf
789 [MDN Array:map]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/map
790 [MDN Array:some]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/some
791 [MDN Array:forEach]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/forEach
792 [Array:every]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/every
793 [Array:filter]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/filter
794 [Array:indexOf]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/indexOf
795 [Array:map]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/map
796 [Array:some]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/some