Push the object onto the end of the array if it is not already present in the array.

var cities = ["Chicago", "Berlin"];
cities.addObject("Lima");    // ["Chicago", "Berlin", "Lima"]
cities.addObject("Berlin");  // ["Chicago", "Berlin", "Lima"]

Adds an observer on a property.

This is the core method used to register an observer for a property.

Once you call this method, any time the key's value is set, your observer will be notified. Note that the observers are triggered any time the value is set, regardless of whether it has actually changed. Your observer should be prepared to handle that.

You can also pass an optional context parameter to this method. The context will be passed to your observer method whenever it is triggered. Note that if you add the same target/method pair on a key multiple times with different context parameters, your observer will only be called once with the last context you passed.

Observer Methods

Observer methods you pass should generally have the following signature if you do not pass a context parameter:

fooDidChange: function(sender, key, value, rev) { };

The sender is the object that changed. The key is the property that changes. The value property is currently reserved and unused. The rev is the last property revision of the object when it changed, which you can use to detect if the key value has really changed or not.

If you pass a context parameter, the context will be passed before the revision like so:

fooDidChange: function(sender, key, value, context, rev) { };

Usually you will not need the value, context or revision parameters at the end. In this case, it is common to write observer methods that take only a sender and key value as parameters or, if you aren't interested in any of these values, to write an observer that has no parameters at all.

Begins a grouping of property changes.

You can use this method to group property changes so that notifications will not be sent until the changes are finished. If you plan to make a large number of changes to an object at one time, you should call this method at the beginning of the changes to begin deferring change notifications. When you are done making changes, call endPropertyChanges() to deliver the deferred change notifications and end deferring.

Returns the cached value of a computed property, if it exists. This allows you to inspect the value of a computed property without accidentally invoking it if it is intended to be generated lazily.

Remove all elements from the array. This is useful if you want to reuse an existing array without having to recreate it.

var colors = ["red", "green", "blue"];
color.length();   //  3
colors.clear();   //  []
colors.length();  //  0

Set the value of a property to the current value minus some amount.

player.decrementProperty('lives');
orc.decrementProperty('health', 5);

Ends a grouping of property changes.

You can use this method to group property changes so that notifications will not be sent until the changes are finished. If you plan to make a large number of changes to an object at one time, you should call beginPropertyChanges() at the beginning of the changes to defer change notifications. When you are done making changes, call this method to deliver the deferred change notifications and end deferring.

Retrieves the value of a property from the object.

This method is usually similar to using object[keyName] or object.keyName, however it supports both computed properties and the unknownProperty handler.

Because get unifies the syntax for accessing all these kinds of properties, it can make many refactorings easier, such as replacing a simple property with a computed property, or vice versa.

Computed Properties

Computed properties are methods defined with the property modifier declared at the end, such as:

fullName: function() {
  return this.get('firstName') + ' ' + this.get('lastName');
}.property('firstName', 'lastName')

When you call get on a computed property, the function will be called and the return value will be returned instead of the function itself.

Unknown Properties

Likewise, if you try to call get on a property whose value is undefined, the unknownProperty() method will be called on the object. If this method returns any value other than undefined, it will be returned instead. This allows you to implement "virtual" properties that are not defined upfront.

To get multiple properties at once, call getProperties with a list of strings or an array:

record.getProperties('firstName', 'lastName', 'zipCode');  // { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

is equivalent to:

record.getProperties(['firstName', 'lastName', 'zipCode']);  // { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

Retrieves the value of a property, or a default value in the case that the property returns undefined.

person.getWithDefault('lastName', 'Doe');

Returns true if the object currently has observers registered for a particular key. You can use this method to potentially defer performing an expensive action until someone begins observing a particular property on the object.

Set the value of a property to the current value plus some amount.

person.incrementProperty('age');
team.incrementProperty('score', 2);

This will use the primitive replace() method to insert an object at the specified index.

var colors = ["red", "green", "blue"];
colors.insertAt(2, "yellow");  // ["red", "green", "yellow", "blue"]
colors.insertAt(5, "orange");  // Error: Index out of range

Convenience method to call propertyWillChange and propertyDidChange in succession.

Pop object from array or nil if none are left. Works just like pop() but it is KVO-compliant.

var colors = ["red", "green", "blue"];
colors.popObject();   // "blue"
console.log(colors);  // ["red", "green"]

Notify the observer system that a property has just changed.

Sometimes you need to change a value directly or indirectly without actually calling get() or set() on it. In this case, you can use this method and propertyWillChange() instead. Calling these two methods together will notify all observers that the property has potentially changed value.

Note that you must always call propertyWillChange and propertyDidChange as a pair. If you do not, it may get the property change groups out of order and cause notifications to be delivered more often than you would like.

Notify the observer system that a property is about to change.

Sometimes you need to change a value directly or indirectly without actually calling get() or set() on it. In this case, you can use this method and propertyDidChange() instead. Calling these two methods together will notify all observers that the property has potentially changed value.

Note that you must always call propertyWillChange and propertyDidChange as a pair. If you do not, it may get the property change groups out of order and cause notifications to be delivered more often than you would like.

Push the object onto the end of the array. Works just like push() but it is KVO-compliant.

var colors = ["red", "green"];
colors.pushObject("black");     // ["red", "green", "black"]
colors.pushObject(["yellow"]);  // ["red", "green", ["yellow"]]

Add the objects in the passed numerable to the end of the array. Defers notifying observers of the change until all objects are added.

var colors = ["red"];
colors.pushObjects(["yellow", "orange"]);  // ["red", "yellow", "orange"]

Remove an object at the specified index using the replace() primitive method. You can pass either a single index, or a start and a length.

If you pass a start and length that is beyond the length this method will throw an OUT_OF_RANGE_EXCEPTION.

var colors = ["red", "green", "blue", "yellow", "orange"];
colors.removeAt(0);     // ["green", "blue", "yellow", "orange"]
colors.removeAt(2, 2);  // ["green", "blue"]
colors.removeAt(4, 2);  // Error: Index out of range

Remove all occurances of an object in the array.

var cities = ["Chicago", "Berlin", "Lima", "Chicago"];
cities.removeObject("Chicago");  // ["Berlin", "Lima"]
cities.removeObject("Lima");     // ["Berlin"]
cities.removeObject("Tokyo")     // ["Berlin"]

Remove an observer you have previously registered on this object. Pass the same key, target, and method you passed to addObserver() and your target will no longer receive notifications.

Required. You must implement this method to apply this mixin.

This is one of the primitives you must implement to support Ember.Array. You should replace amt objects started at idx with the objects in the passed array. You should also call this.enumerableContentDidChange()

Reverse objects in the array. Works just like reverse() but it is KVO-compliant.

Sets the provided key or path to the value.

This method is generally very similar to calling object[key] = value or object.key = value, except that it provides support for computed properties, the setUnknownProperty() method and property observers.

Computed Properties

If you try to set a value on a key that has a computed property handler defined (see the get() method for an example), then set() will call that method, passing both the value and key instead of simply changing the value itself. This is useful for those times when you need to implement a property that is composed of one or more member properties.

Unknown Properties

If you try to set a value on a key that is undefined in the target object, then the setUnknownProperty() handler will be called instead. This gives you an opportunity to implement complex "virtual" properties that are not predefined on the object. If setUnknownProperty() returns undefined, then set() will simply set the value on the object.

Property Observers

In addition to changing the property, set() will also register a property change with the object. Unless you have placed this call inside of a beginPropertyChanges() and endPropertyChanges(), any "local" observers (i.e. observer methods declared on the same object), will be called immediately. Any "remote" observers (i.e. observer methods declared on another object) will be placed in a queue and called at a later time in a coalesced manner.

Chaining

In addition to property changes, set() returns the value of the object itself so you can do chaining like this:

record.set('firstName', 'Charles').set('lastName', 'Jolley');

Replace all the the receiver's content with content of the argument. If argument is an empty array receiver will be cleared.

var colors = ["red", "green", "blue"];
colors.setObjects(["black", "white"]);  // ["black", "white"]
colors.setObjects([]);                  // []

Sets a list of properties at once. These properties are set inside a single beginPropertyChanges and endPropertyChanges batch, so observers will be buffered.

record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });

Shift an object from start of array or nil if none are left. Works just like shift() but it is KVO-compliant.

var colors = ["red", "green", "blue"];
colors.shiftObject();  // "red"
console.log(colors);   // ["green", "blue"]

Set the value of a boolean property to the opposite of it's current value.

starship.toggleProperty('warpDriveEngaged');

Unshift an object to start of array. Works just like unshift() but it is KVO-compliant.

var colors = ["red"];
colors.unshiftObject("yellow");    // ["yellow", "red"]
colors.unshiftObject(["black"]);   // [["black"], "yellow", "red"]

Adds the named objects to the beginning of the array. Defers notifying observers until all objects have been added.

var colors = ["red"];
colors.unshiftObjects(["black", "white"]);   // ["black", "white", "red"]
colors.unshiftObjects("yellow"); // Type Error: 'undefined' is not a function