Docs/Types/Array.md

   1 Type: Array {#Array}
   2 ====================
   3
   4 A collection of Array methods and functions.
   5
   6 ### See Also:
   7
   8 - [MDC Array][]
   9
  10
  11 Function: Array.each {#Array:Array-each}
  12 ----------------------------------
  13
  14 Used to iterate through arrays, or iterables that are not regular arrays, such as built in getElementsByTagName calls or arguments of a function.
  15
  16 ### Syntax:
  17
  18         Array.each(iterable, fn[, bind]);
  19
  20 ### Arguments:
  21
  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][].
  25
  26 #### Argument: fn
  27
  28 ##### Syntax:
  29
  30         fn(item, index, object)
  31
  32 ##### Arguments:
  33
  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.
  37
  38 ### Example:
  39
  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.
  43
  44 ### See Also:
  45
  46 - [Array:each](#Array:each)
  47
  48 ### Notes:
  49
  50 This is an array-specific equivalent of *$each* from MooTools 1.2.
  51
  52
  53
  54 Function: Array.clone {#Array:Array-clone}
  55 ------------------------------------
  56
  57 Returns a copy of the passed array.
  58
  59 ### Syntax:
  60
  61         var clone = Array.clone(myArray);
  62
  63 ### Arguments:
  64
  65 1. myArray      - (*array*) The array you wish to copy.
  66
  67 ### Returns:
  68
  69 * (*array*) a copy of the passed array.
  70
  71 ### Example:
  72
  73         var myArray = ['red', 'blue', 'green'];
  74         var otherArray = Array.clone(myArray);
  75
  76         var myArray[0] = 'yellow';
  77
  78         alert(myArray[0]);              // alerts 'yellow'
  79         alert(otherArray[0])    // alerts 'red'
  80
  81 ### Notes:
  82
  83 This is an array-specific equivalent of *$unlink* from MooTools 1.2.
  84
  85
  86
  87 Function: Array.from {#Array:Array-from}
  88 ----------------------------------
  89
  90 Converts the argument passed in to an array if it is defined and not already an array.
  91
  92 ### Syntax:
  93
  94         var splatted = Array.from(obj);
  95
  96 ### Arguments:
  97
  98 1. obj - (*mixed*) Any type of variable.
  99
 100 ### Returns:
 101
 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.
 103
 104 ### Example:
 105
 106         Array.from('hello'); // returns ['hello'].
 107         Array.from(['a', 'b', 'c']); // returns ['a', 'b', 'c'].
 108
 109 ### Notes:
 110
 111 This is equivalent to *$splat* from MooTools 1.2.
 112
 113
 114
 115 Array method: each {#Array:each}
 116 ---------------------------------
 117
 118 Calls a function for each element in the array.
 119
 120 ### Syntax:
 121
 122         myArray.each(fn[, bind]);
 123
 124 ### Arguments:
 125
 126 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.
 127 2. bind - (*object*, optional) The object to be used as 'this' in the function. For more information see [Function:bind][].
 128
 129 #### Argument: fn
 130
 131 ##### Syntax
 132
 133         fn(item, index, array)
 134
 135 ##### Arguments:
 136
 137 1. item   - (*mixed*) The current item in the array.
 138 2. index  - (*number*) The current item's index in the array.
 139 3. array  - (*array*) The actual array.
 140
 141 ### Examples:
 142
 143         //Alerts "0 = apple", "1 = banana", and so on:
 144         ['apple', 'banana', 'lemon'].each(function(item, index){
 145                 alert(index + " = " + item);
 146         }); //The optional second argument for binding isn't used here.
 147
 148
 149 ### See Also:
 150
 151 - [Array.each](#Array:Array-each)
 152 - [MDC Array:forEach][]
 153
 154 ### Notes:
 155
 156 - This method is only available for browsers without native [MDC Array:forEach][] support.
 157
 158
 159
 160
 161
 162
 163 Array method: invoke {#Array:invoke}
 164 --------------------------
 165
 166 Returns an array with the named method applied to the array's contents.
 167
 168 ### Syntax:
 169
 170         var arr = myArray.invoke(method[, arg, arg, arg ...])
 171
 172 ### Arguments:
 173
 174 1. method - (*string*) The method to apply to each item in the array.
 175 2. arg - (*mixed*) Any number of arguments to pass to the named method.
 176
 177 ### Returns:
 178
 179 * (*array*) A new array containing the results of the applied method.
 180
 181 ### Example:
 182
 183         var foo = [4, 8, 15, 16, 23, 42];
 184         var bar = foo.invoke('limit', 10, 30);  //bar is now [10, 10, 15, 16, 23, 30]
 185
 186
 187
 188 Array method: every {#Array:every}
 189 ----------------------------
 190
 191 Returns true if every element in the array satisfies the provided testing function.
 192 This method is provided only for browsers without native [Array:every][] support.
 193
 194 ### Syntax:
 195
 196         var allPassed = myArray.every(fn[, bind]);
 197
 198 ### Arguments:
 199
 200 1. fn   - (*function*) The function to test for each element.
 201 2. bind - (*object*, optional) The object to use as 'this' in the function. For more information see [Function:bind][].
 202
 203 #### Argument: fn
 204
 205 ##### Syntax:
 206
 207         fn(item, index, array)
 208
 209 ##### Arguments:
 210
 211 1. item   - (*mixed*) The current item in the array.
 212 2. index  - (*number*) The current item's index in the array.
 213 3. array  - (*array*) The actual array.
 214
 215 ### Returns:
 216
 217 * (*boolean*) If every element in the array satisfies the provided testing function, returns true. Otherwise, returns false.
 218
 219 ### Examples:
 220
 221         var areAllBigEnough = [10, 4, 25, 100].every(function(item, index){
 222                 return item > 20;
 223         }); // areAllBigEnough = false
 224
 225
 226 ### See Also:
 227
 228 - [MDC Array:every][]
 229
 230
 231
 232 Array method: filter {#Array:filter}
 233 ------------------------------
 234
 235 Creates a new array with all of the elements of the array for which the provided filtering function returns true.
 236 This method is provided only for browsers without native [Array:filter][] support.
 237
 238 ### Syntax:
 239
 240         var filteredArray = myArray.filter(fn[, bind]);
 241
 242 ### Arguments:
 243
 244 1. fn   - (*function*) The function to test each element of the array. This function is passed the item and its index in the array.
 245 2. bind - (*object*, optional) The object to use as 'this' in the function. For more information see [Function:bind][].
 246
 247 #### Argument: fn
 248
 249 ##### Syntax:
 250
 251         fn(item, index, array)
 252
 253 ##### Arguments:
 254
 255 1. item   - (*mixed*) The current item in the array.
 256 2. index  - (*number*) The current item's index in the array.
 257 3. array  - (*array*) The actual array.
 258
 259 ### Returns:
 260
 261 * (*array*) The new filtered array.
 262
 263 ### Examples:
 264
 265         var biggerThanTwenty = [10, 3, 25, 100].filter(function(item, index){
 266                 return item > 20;
 267         }); // biggerThanTwenty = [25, 100]
 268
 269 ### See Also:
 270
 271 - [MDC Array:filter][]
 272
 273
 274
 275 Array method: clean {#Array:clean}
 276 ----------------------------
 277
 278 Creates a new array with all of the elements of the array which are defined (i.e. not null or undefined).
 279
 280 ### Syntax:
 281
 282         var cleanedArray = myArray.clean();
 283
 284 ### Returns:
 285
 286 * (*array*) The new filtered array.
 287
 288 ### Examples:
 289
 290         var myArray = [null, 1, 0, true, false, 'foo', undefined, ''];
 291         myArray.clean() // returns [1, 0, true, false, 'foo', '']
 292
 293
 294
 295 Array method: indexOf {#Array:indexOf}
 296 --------------------------------
 297
 298 Returns the index of the first element within the array equal to the specified value, or -1 if the value is not found.
 299 This method is provided only for browsers without native [Array:indexOf][] support.
 300
 301 ### Syntax:
 302
 303         var index = myArray.indexOf(item[, from]);
 304
 305 ### Returns:
 306
 307 * (*number*) The index of the first element within the array equal to the specified value. If not found, returns -1.
 308
 309 ### Arguments:
 310
 311 1. item - (*object*) The item to search for in the array.
 312 2. from - (*number*, optional: defaults to 0) The index of the array at which to begin the search.
 313
 314 ### Examples:
 315
 316         ['apple', 'lemon', 'banana'].indexOf('lemon'); // returns 1
 317         ['apple', 'lemon'].indexOf('banana'); // returns -1
 318
 319 ### See Also:
 320
 321 - [MDC Array:indexOf][]
 322
 323
 324
 325 Array method: map {#Array:map}
 326 ------------------------
 327
 328 Creates a new array with the results of calling a provided function on every element in the array.
 329 This method is provided only for browsers without native [Array:map][] support.
 330
 331 ### Syntax:
 332
 333         var mappedArray = myArray.map(fn[, bind]);
 334
 335 ### Arguments:
 336
 337 1. fn   - (*function*) The function to produce an element of the new Array from an element of the current one.
 338 2. bind - (*object*, optional) The object to use as 'this' in the function. For more information see [Function:bind][].
 339
 340 #### Argument: fn
 341
 342 ##### Syntax:
 343
 344         fn(item, index, array)
 345
 346 ##### Arguments:
 347
 348 1. item   - (*mixed*) The current item in the array.
 349 2. index  - (*number*) The current item's index in the array.
 350 3. array  - (*array*) The actual array.
 351
 352 ### Returns:
 353
 354 * (*array*) The new mapped array.
 355
 356 ### Examples:
 357
 358         var timesTwo = [1, 2, 3].map(function(item, index){
 359                 return item * 2;
 360         }); //timesTwo = [2, 4, 6];
 361
 362 ### See Also:
 363
 364 - [MDC Array:map][]
 365
 366
 367
 368 Array method: some {#Array:some}
 369 --------------------------
 370
 371 Returns true if at least one element in the array satisfies the provided testing function.
 372 This method is provided only for browsers without native [Array:some][] support.
 373
 374 ### Syntax:
 375
 376         var somePassed = myArray.some(fn[, bind]);
 377
 378 ### Returns:
 379
 380 * (*boolean*) If at least one element in the array satisfies the provided testing function returns true. Otherwise, returns false.
 381
 382 ### Arguments:
 383
 384 1. fn   - (*function*) The function to test for each element. This function is passed the item and its index in the array.
 385 2. bind - (*object*, optional) The object to use as 'this' in the function. For more information see [Function:bind][].
 386
 387 #### Argument: fn
 388
 389 ##### Syntax:
 390
 391         fn(item, index, array)
 392
 393 ##### Arguments:
 394
 395 1. item   - (*mixed*) The current item in the array.
 396 2. index  - (*number*) The current item's index in the array.
 397 3. array  - (*array*) The actual array.
 398
 399 ### Examples:
 400
 401         var isAnyBigEnough = [10, 4, 25, 100].some(function(item, index){
 402                 return item > 20;
 403         }); // isAnyBigEnough = true
 404
 405 ### See Also:
 406
 407 - [MDC Array:some][]
 408
 409
 410
 411 Array method: associate {#Array:associate}
 412 ------------------------------------
 413
 414 Creates an object with key-value pairs based on the array of keywords passed in and the current content of the array.
 415
 416 ### Syntax:
 417
 418         var associated = myArray.associate(obj);
 419
 420 ### Arguments:
 421
 422 1. obj - (*array*) Its items will be used as the keys of the object that will be created.
 423
 424 ### Returns:
 425
 426 * (*object*) The new associated object.
 427
 428 ### Examples:
 429
 430         var animals = ['Cow', 'Pig', 'Dog', 'Cat'];
 431         var sounds = ['Moo', 'Oink', 'Woof', 'Miao'];
 432         sounds.associate(animals);
 433         // returns {'Cow': 'Moo', 'Pig': 'Oink', 'Dog': 'Woof', 'Cat': 'Miao'}
 434
 435
 436
 437 Array method: link {#Array:link}
 438 --------------------------
 439
 440 Accepts an object of key / function pairs to assign values.
 441
 442 ### Syntax:
 443
 444         var result = myArray.link(object);
 445
 446 ### Arguments:
 447
 448 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.
 449
 450 ### Returns:
 451
 452 * (*object*) The new associated object.
 453
 454 ### Examples:
 455
 456         var el = document.createElement('div');
 457         var arr2 = [100, 'Hello', {foo: 'bar'}, el, false];
 458         arr2.link({
 459                 myNumber: Type.isNumber,
 460                 myElement: Type.isElement,
 461                 myObject: Type.isObject,
 462                 myString: Type.isString,
 463                 myBoolean: function(obj){ return obj != null; }
 464         });
 465         // returns {myNumber: 100, myElement: el, myObject: {foo: 'bar'}, myString: 'Hello', myBoolean: false}
 466
 467
 468 Array method: contains {#Array:contains}
 469 ----------------------------------
 470
 471 Tests an array for the presence of an item.
 472
 473 ### Syntax:
 474
 475         var inArray = myArray.contains(item[, from]);
 476
 477 ### Arguments:
 478
 479 1. item - (*object*) The item to search for in the array.
 480 2. from - (*number*, optional: defaults to 0) The index of the array at which to begin the search.
 481
 482 ### Returns:
 483
 484 * (*boolean*) If the array contains the item specified, returns true. Otherwise, returns false.
 485
 486 ### Examples:
 487
 488         ['a', 'b', 'c'].contains('a'); // returns true
 489         ['a', 'b', 'c'].contains('d'); // returns false
 490
 491 ### See Also:
 492
 493 - [MDC Array:indexOf][]
 494
 495
 496
 497 Array method: append {#Array:append}
 498 ------------------------------
 499
 500 Appends the passed array to the end of the current array.
 501
 502 ### Syntax:
 503
 504         var myArray = myArray.append(otherArray);
 505
 506 ### Arguments:
 507
 508 1. otherArray - (*array*) The array containing values you wish to append.
 509
 510 ### Returns:
 511
 512 * (*array*) The original array including the new values.
 513
 514 ### Examples:
 515
 516         var myOtherArray = ['green', 'yellow'];
 517         ['red', 'blue'].append(myOtherArray); // returns ['red', 'blue', 'green', 'yellow'];
 518
 519 ### Notes:
 520
 521 This is an array-specific equivalent of *$extend* from MooTools 1.2.
 522
 523
 524
 525 Array method: getLast {#Array:getLast}
 526 --------------------------------
 527
 528 Returns the last item from the array.
 529
 530 ### Syntax:
 531
 532         myArray.getLast();
 533
 534 ### Returns:
 535
 536 * (*mixed*) The last item in this array.
 537 * (*null*) If this array is empty, returns null.
 538
 539 ### Examples:
 540
 541         ['Cow', 'Pig', 'Dog', 'Cat'].getLast(); // returns 'Cat'
 542
 543
 544
 545 Array method: getRandom {#Array:getRandom}
 546 ------------------------------------
 547
 548 Returns a random item from the array.
 549
 550 ### Syntax:
 551
 552         myArray.getRandom();
 553
 554 ### Returns:
 555
 556 * (*mixed*) A random item from this array. If this array is empty, returns null.
 557
 558 ### Examples:
 559
 560         ['Cow', 'Pig', 'Dog', 'Cat'].getRandom(); // returns one of the items
 561
 562
 563
 564 Array method: include {#Array:include}
 565 --------------------------------
 566
 567 Pushes the passed element into the array if it's not already present (case and type sensitive).
 568
 569 ### Syntax:
 570
 571         myArray.include(item);
 572
 573 ### Arguments:
 574
 575 1. item - (*object*) The item that should be added to this array.
 576
 577 ### Returns:
 578
 579 * (*array*) This array with the new item included.
 580
 581 ### Examples:
 582
 583         ['Cow', 'Pig', 'Dog'].include('Cat'); // returns ['Cow', 'Pig', 'Dog', 'Cat']
 584         ['Cow', 'Pig', 'Dog'].include('Dog'); // returns ['Cow', 'Pig', 'Dog']
 585
 586 ### Notes:
 587
 588 If you want to push the passed element even if it's already present, use
 589 the vanilla javascript:
 590
 591         myArray.push(item);
 592
 593 Array method: combine {#Array:combine}
 594 --------------------------------
 595
 596 Combines an array with all the items of another. Does not allow duplicates and is case and type sensitive.
 597
 598 ### Syntax:
 599
 600         myArray.combine(array);
 601
 602 ### Arguments:
 603
 604 1. array - (*array*) The array whose items should be combined into this array.
 605
 606 ### Returns:
 607
 608 * (*array*) This array combined with the new items.
 609
 610 ### Examples:
 611
 612         var animals = ['Cow', 'Pig', 'Dog'];
 613         animals.combine(['Cat', 'Dog']); //animals = ['Cow', 'Pig', 'Dog', 'Cat'];
 614
 615
 616
 617 Array method: erase {#Array:erase}
 618 ----------------------------
 619
 620 Removes all occurrences of an item from the array.
 621
 622 ### Syntax:
 623
 624         myArray.erase(item);
 625
 626 ### Arguments:
 627
 628 1. item - (*object*) The item to search for in the array.
 629
 630 ### Returns:
 631
 632 * (*array*) This array with all occurrences of the item removed.
 633
 634 ### Examples:
 635
 636         ['Cow', 'Pig', 'Dog', 'Cat', 'Dog'].erase('Dog') // returns ['Cow', 'Pig', 'Cat']
 637         ['Cow', 'Pig', 'Dog'].erase('Cat') // returns ['Cow', 'Pig', 'Dog']
 638
 639
 640
 641 Array method: empty {#Array:empty}
 642 ----------------------------
 643
 644 Empties an array.
 645
 646 ### Syntax:
 647
 648         myArray.empty();
 649
 650 ### Returns:
 651
 652 * (*array*) This array, emptied.
 653
 654 ### Examples:
 655
 656         var myArray = ['old', 'data'];
 657         myArray.empty(); //myArray is now []
 658
 659
 660 Array method: flatten {#Array:flatten}
 661 --------------------------------
 662
 663 Flattens a multidimensional array into a single array.
 664
 665 ### Syntax:
 666
 667         myArray.flatten();
 668
 669 ### Returns:
 670
 671 * (*array*) A new flat array.
 672
 673 ### Examples:
 674
 675         var myArray = [1,2,3,[4,5, [6,7]], [[[8]]]];
 676         var newArray = myArray.flatten(); //newArray is [1,2,3,4,5,6,7,8]
 677
 678
 679
 680 Array method: pick {#Array:pick}
 681 --------------------------
 682 Returns the first defined value of the array passed in, or null.
 683
 684 ### Syntax:
 685
 686         var picked = [var1, var2, var3].pick();
 687
 688 ### Returns:
 689
 690 * (*mixed*) The first variable that is defined.
 691 * (*null*) If all variables passed in are `null` or `undefined`, returns `null`.
 692
 693 ### Example:
 694
 695         function say(infoMessage, errorMessage){
 696                 alert([errorMessage, infoMessage, 'There was no message supplied.'].pick());
 697
 698                 //or more MooTools 1.2 style using Generics
 699                 Array.pick([errorMessage, infoMessage, 'There was no message supplied.']);
 700
 701         }
 702         say(); // alerts 'There was no message supplied.'
 703     say('This is an info message.'); // alerts 'This is an info message.'
 704     say('This message will be ignored.', 'This is the error message.'); // alerts 'This is the error message.'
 705
 706
 707 ### Notes:
 708
 709 This is equivalent to *$pick* from MooTools 1.2.
 710
 711
 712
 713 Array method: hexToRgb {#Array:hexToRgb}
 714 ----------------------------------
 715
 716 Converts an hexadecimal color value to RGB. Input array must be the following hexadecimal color format.
 717 \['FF', 'FF', 'FF'\]
 718
 719 ### Syntax:
 720
 721         myArray.hexToRgb([array]);
 722
 723 ### Arguments:
 724
 725 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)").
 726
 727 ### Returns:
 728
 729 * (*string*) A string representing the color in RGB.
 730 * (*array*) If the array flag is set, an array will be returned instead.
 731
 732 ### Examples:
 733
 734         ['11', '22', '33'].hexToRgb(); // returns 'rgb(17, 34, 51)'
 735         ['11', '22', '33'].hexToRgb(true); // returns [17, 34, 51]
 736
 737 ### See Also:
 738
 739 - [String:hexToRgb](/Types/String/#hexToRgb)
 740
 741
 742
 743 Array method: rgbToHex {#Array:rgbToHex}
 744 ----------------------------------
 745
 746 Converts an RGB color value to hexadecimal. Input array must be in one of the following RGB color formats.
 747 \[255, 255, 255\], or \[255, 255, 255, 1\]
 748
 749 ### Syntax:
 750
 751         myArray.rgbToHex([array]);
 752
 753 ### Arguments:
 754
 755 1. array - (*boolean*, optional) If true is passed, will output an array (e.g. \['ff', '33', '00'\]) instead of a string (e.g. '#ff3300').
 756
 757 ### Returns:
 758
 759 * (*string*) A string representing the color in hexadecimal, or 'transparent' string if the fourth value of rgba in the input array is 0 (rgba).
 760 * (*array*) If the array flag is set, an array will be returned instead.
 761
 762 ### Examples:
 763
 764         [17, 34, 51].rgbToHex(); // returns '#112233'
 765         [17, 34, 51].rgbToHex(true); // returns ['11', '22', '33']
 766         [17, 34, 51, 0].rgbToHex(); // returns 'transparent'
 767
 768 ### See Also:
 769
 770 - [String:rgbToHex](/Types/String/#rgbToHex)
 771
 772
 773
 774 [Function:bind]: /core/Native/Function/#Function:bind
 775 [MDC Array]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array
 776 [MDC Array:every]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/every
 777 [MDC Array:filter]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/filter
 778 [MDC Array:indexOf]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/indexOf
 779 [MDC Array:map]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/map
 780 [MDC Array:some]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/some
 781 [MDC Array:forEach]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/forEach
 782 [Array:every]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/every
 783 [Array:filter]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/filter
 784 [Array:indexOf]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/indexOf
 785 [Array:map]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/map
 786 [Array:some]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/some