Class Ember.Array public
This mixin implements Observer-friendly Array-like behavior. It is not a concrete implementation, but it can be used up by other classes that want to appear like arrays.
For example, ArrayProxy and ArrayController are both concrete classes that can be instantiated to implement array-like behavior. Both of these classes use the Array Mixin by way of the MutableArray mixin, which allows observable changes to be made to the underlying array.
Unlike Ember.Enumerable, this mixin defines methods specifically for
collections that provide index-ordered access to their contents. When you
are designing code that needs to accept any kind of Array-like object, you
should use these methods instead of Array primitives because these will
properly notify observers of changes to the array.
Although these methods are efficient, they do add a layer of indirection to your application so it is a good idea to use them only when you need the flexibility of using both true JavaScript arrays and "virtual" arrays such as controllers and collections.
You can use the methods defined in this module to access and modify array
contents in a KVO-friendly way. You can also be notified whenever the
membership of an array changes by using .observes('myArray.[]').
To support Ember.Array in your own class, you must override two
primitives to use it: replace() and objectAt().
Note that the Ember.Array mixin also incorporates the Ember.Enumerable
mixin. All Ember.Array-like objects are also enumerable.
Methods
addArrayObserver (target, opts) : Ember.Array public
Defined in packages/ember-runtime/lib/mixins/array.js:337
- target
- Object
The observer object.
- opts
- Object
Optional hash of configuration options including
willChangeanddidChangeoption.- returns
- Ember.Array
receiver
Adds an array observer to the receiving array. The array observer object normally must implement two methods:
arrayWillChange(observedObj, start, removeCount, addCount)- This method will be called just before the array is modified.arrayDidChange(observedObj, start, removeCount, addCount)- This method will be called just after the array is modified.
Both callbacks will be passed the observed object, starting index of the change as well a a count of the items to be removed and added. You can use these callbacks to optionally inspect the array during the change, clear caches, or do any other bookkeeping necessary.
In addition to passing a target, you can also include an options hash which you can use to override the method names that will be invoked on the target.
arrayContentDidChange (startIdx, removeAmt, addAmt) : Ember.Array public
Defined in packages/ember-runtime/lib/mixins/array.js:449
- startIdx
- Number
The starting index in the array that did change.
- removeAmt
- Number
The number of items that were removed. If you pass
nullassumes 0- addAmt
- Number
The number of items that were added. If you pass
nullassumes 0.- returns
- Ember.Array
receiver
If you are implementing an object that supports Ember.Array, call this
method just after the array content changes to notify any observers and
invalidate any related properties. Pass the starting index of the change
as well as a delta of the amounts to change.
arrayContentWillChange (startIdx, removeAmt, addAmt) : Ember.Array public
Defined in packages/ember-runtime/lib/mixins/array.js:394
- startIdx
- Number
The starting index in the array that will change.
- removeAmt
- Number
The number of items that will be removed. If you pass
nullassumes 0- addAmt
- Number
The number of items that will be added. If you pass
nullassumes 0.- returns
- Ember.Array
receiver
If you are implementing an object that supports Ember.Array, call this
method just before the array content changes to notify any observers and
invalidate any related properties. Pass the starting index of the change
as well as a delta of the amounts to change.
compact : Array public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:914
- returns
- Array
the array without null and undefined elements.
Returns a copy of the array with all null and undefined elements removed.
var arr = ['a', null, 'c', undefined];
arr.compact(); // ['a', 'c']contains (obj) : Boolean public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:213
- obj
- Object
The object to search for.
- returns
- Boolean
trueif object is found in enumerable.
Returns true if the passed object can be found in the receiver. The
default version will iterate through the enumerable until the object
is found. You may want to override this with a more efficient version.
var arr = ['a', 'b', 'c'];
arr.contains('a'); // true
arr.contains('z'); // falseevery (callback, target) : Boolean public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:613
- callback
- Function
The callback to execute
- target
- Object
The target object to use
- returns
- Boolean
Returns true if the passed function returns true for every item in the
enumeration. This corresponds with the every() method in JavaScript 1.6.
The callback method you provide should have the following signature (all parameters are optional):
function(item, index, enumerable);
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
It should return the true or false.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
Example Usage:
if (people.every(isEngineer)) {
Paychecks.addBigBonus();
}filter (callback, target) : Array public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:381
- callback
- Function
The callback to execute
- target
- Object
The target object to use
- returns
- Array
A filtered array.
Returns an array with all of the items in the enumeration that the passed
function returns true for. This method corresponds to filter() defined in
JavaScript 1.6.
The callback method you provide should have the following signature (all parameters are optional):
function(item, index, enumerable);
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
It should return true to include the item in the results, false
otherwise.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
filterBy (key, value) : Array public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:455
- key
- String
the property to test
- value
- *
optional value to test against.
- returns
- Array
filtered array
Returns an array with just the items with the matched property. You
can pass an optional second argument with the target value. Otherwise
this will match any property that evaluates to true.
find (callback, target) : Object public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:523
- callback
- Function
The callback to execute
- target
- Object
The target object to use
- returns
- Object
Found item or
undefined.
Returns the first item in the array for which the callback returns true.
This method works similar to the filter() method defined in JavaScript 1.6
except that it will stop working on the array once a match is found.
The callback method you provide should have the following signature (all parameters are optional):
function(item, index, enumerable);
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
It should return the true to include the item in the results, false
otherwise.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
findBy (key, value) : Object public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:580
- key
- String
the property to test
- value
- String
optional value to test against.
- returns
- Object
found item or
undefined
Returns the first item with a property matching the passed value. You
can pass an optional second argument with the target value. Otherwise
this will match any property that evaluates to true.
This method works much like the more generic find() method.
forEach (callback, target) : Object public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:238
- callback
- Function
The callback to execute
- target
- Object
The target object to use
- returns
- Object
receiver
Iterates through the enumerable, calling the passed function on each
item. This method corresponds to the forEach() method defined in
JavaScript 1.6.
The callback method you provide should have the following signature (all parameters are optional):
function(item, index, enumerable);
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
getEach (key) : Array public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:289
- key
- String
name of the property
- returns
- Array
The mapped array.
Alias for mapBy
indexOf (object, startAt) : Number public
Defined in packages/ember-runtime/lib/mixins/array.js:245
- object
- Object
the item to search for
- startAt
- Number
optional starting location to search, default 0
- returns
- Number
index or -1 if not found
Returns the index of the given object's first occurrence.
If no startAt argument is given, the starting location to
search is 0. If it's negative, will count backward from
the end of the array. Returns -1 if no match is found.
var arr = ['a', 'b', 'c', 'd', 'a'];
arr.indexOf('a'); // 0
arr.indexOf('z'); // -1
arr.indexOf('a', 2); // 4
arr.indexOf('a', -1); // 4
arr.indexOf('b', 3); // -1
arr.indexOf('a', 100); // -1isEvery (key, value) : Boolean public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:674
Available since v1.3.0
- key
- String
the property to test
- value
- String
optional value to test against. Defaults to
true- returns
- Boolean
Returns true if the passed property resolves to the value of the second
argument for all items in the enumerable. This method is often simpler/faster
than using a callback.
lastIndexOf (object, startAt) : Number public
Defined in packages/ember-runtime/lib/mixins/array.js:289
- object
- Object
the item to search for
- startAt
- Number
optional starting location to search, default 0
- returns
- Number
index or -1 if not found
Returns the index of the given object's last occurrence.
If no startAt argument is given, the search starts from
the last position. If it's negative, will count backward
from the end of the array. Returns -1 if no match is found.
var arr = ['a', 'b', 'c', 'd', 'a'];
arr.lastIndexOf('a'); // 4
arr.lastIndexOf('z'); // -1
arr.lastIndexOf('a', 2); // 0
arr.lastIndexOf('a', -1); // 4
arr.lastIndexOf('b', 3); // 1
arr.lastIndexOf('a', 100); // 4map (callback, target) : Array public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:317
- callback
- Function
The callback to execute
- target
- Object
The target object to use
- returns
- Array
The mapped array.
Maps all of the items in the enumeration to another value, returning
a new array. This method corresponds to map() defined in JavaScript 1.6.
The callback method you provide should have the following signature (all parameters are optional):
function(item, index, enumerable);
itemis the current item in the iteration.indexis the current index in the iteration.enumerableis the enumerable object itself.
It should return the mapped value.
Note that in addition to a callback, you can also pass an optional target
object that will be set as this on the context. This is a good way
to give your iterator function access to the current object.
mapBy (key) : Array public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:354
- key
- String
name of the property
- returns
- Array
The mapped array.
Similar to map, this specialized function returns the value of the named property on all items in the enumeration.
objectAt (idx) : * public
Defined in packages/ember-runtime/lib/mixins/array.js:104
- idx
- Number
The index of the item to return.
- returns
- *
item at index or undefined
Returns the object at the given index. If the given index is negative
or is greater or equal than the array length, returns undefined.
This is one of the primitives you must implement to support Ember.Array.
If your object supports retrieving the value of an array item using get()
(i.e. myArray.get(0)), then you do not need to implement this method
yourself.
var arr = ['a', 'b', 'c', 'd'];
arr.objectAt(0); // 'a'
arr.objectAt(3); // 'd'
arr.objectAt(-1); // undefined
arr.objectAt(4); // undefined
arr.objectAt(5); // undefinedobjectsAt (indexes) : Array public
Defined in packages/ember-runtime/lib/mixins/array.js:136
- indexes
- Array
An array of indexes of items to return.
- returns
- Array
This returns the objects at the specified indexes, using objectAt.
var arr = ['a', 'b', 'c', 'd'];
arr.objectsAt([0, 1, 2]); // ['a', 'b', 'c']
arr.objectsAt([2, 3, 4]); // ['c', 'd', undefined]reject (callback, target) : Array public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:422
- callback
- Function
The callback to execute
- target
- Object
The target object to use
- returns
- Array
A rejected array.
Returns an array with all of the items in the enumeration where the passed function returns false. This method is the inverse of filter().
The callback method you provide should have the following signature (all parameters are optional):
function(item, index, enumerable);
- item is the current item in the iteration.
- index is the current index in the iteration
- enumerable is the enumerable object itself.
It should return a falsey value to include the item in the results.
Note that in addition to a callback, you can also pass an optional target object that will be set as "this" on the context. This is a good way to give your iterator function access to the current object.
rejectBy (key, value) : Array public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:484
- key
- String
the property to test
- value
- String
optional value to test against.
- returns
- Array
rejected array
Returns an array with the items that do not have truthy values for key. You can pass an optional second argument with the target value. Otherwise this will match any property that evaluates to false.
removeArrayObserver (target, opts) : Ember.Array public
Defined in packages/ember-runtime/lib/mixins/array.js:367
- target
- Object
The object observing the array.
- opts
- Object
Optional hash of configuration options including
willChangeanddidChangeoption.- returns
- Ember.Array
receiver
Removes an array observer from the object if the observer is current registered. Calling this method multiple times with the same object will have no effect.
setEach (key, value) : Object public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:299
- key
- String
The key to set
- value
- Object
The object to set
- returns
- Object
receiver
Sets the value on the named property for each member. This is more
efficient than using other methods defined on this helper. If the object
implements Ember.Observable, the value will be changed to set(), otherwise
it will be set directly. null objects are skipped.
slice (beginIndex, endIndex) : Array public
Defined in packages/ember-runtime/lib/mixins/array.js:199
- beginIndex
- Number
(Optional) index to begin slicing from.
- endIndex
- Number
(Optional) index to end the slice at (but not included).
- returns
- Array
New array with specified slice
Returns a new array that is a slice of the receiver. This implementation uses the observable array methods to retrieve the objects for the new slice.
var arr = ['red', 'green', 'blue'];
arr.slice(0); // ['red', 'green', 'blue']
arr.slice(0, 2); // ['red', 'green']
arr.slice(1, 100); // ['green', 'blue']sortBy (property) : Array public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:1189
Available since v1.2.0
- property
- String
name(s) to sort on
- returns
- Array
The sorted array.
Converts the enumerable into an array and sorts by the keys specified in the argument.
You may provide multiple arguments to sort by multiple properties.
without (value) : Ember.Enumerable public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:932
- value
- Object
- returns
- Ember.Enumerable
Returns a new enumerable that excludes the passed value. The default implementation returns an array regardless of the receiver type unless the receiver does not contain the value.
var arr = ['a', 'b', 'a', 'c'];
arr.without('a'); // ['b', 'c']Properties
@each public
Defined in packages/ember-runtime/lib/mixins/array.js:516
Returns a special object that can be used to observe individual properties on the array. Just get an equivalent property on this object and it will return an enumerable that maps automatically to the named key on the member objects.
If you merely want to watch for any items being added or removed to the array,
use the [] property instead of @each.
[] : public
Defined in packages/ember-runtime/lib/mixins/array.js:164
- returns
this
This is the handler for the special array content property. If you get this property, it will return this. If you set this property to a new array, it will replace the current content.
This property overrides the default property defined in Ember.Enumerable.
firstObject : Object public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:138
- returns
- Object
the object or undefined
Helper method returns the first object from a collection. This is usually used by bindings and other parts of the framework to extract a single object if the enumerable contains only one item.
If you override this method, you should implement it so that it will
always return the same value each time it is called. If your enumerable
contains only one object, this method should always return that object.
If your enumerable is empty, this method should return undefined.
var arr = ['a', 'b', 'c'];
arr.get('firstObject'); // 'a'
var arr = [];
arr.get('firstObject'); // undefinedhasArrayObservers public
Defined in packages/ember-runtime/lib/mixins/array.js:383
Becomes true whenever the array currently has observers watching changes on the array.
lastObject : Object public
Inherited from Ember.Enumerable packages/ember-runtime/lib/mixins/enumerable.js:174
- returns
- Object
the last object or undefined
Helper method returns the last object from a collection. If your enumerable
contains only one object, this method should always return that object.
If your enumerable is empty, this method should return undefined.
var arr = ['a', 'b', 'c'];
arr.get('lastObject'); // 'c'
var arr = [];
arr.get('lastObject'); // undefinedlength public
Defined in packages/ember-runtime/lib/mixins/array.js:93
Required. You must implement this method to apply this mixin.
Your array must support the length property. Your replace methods should
set this property whenever it changes.