API Docs for: v2.11.1
Show:

Ember.ArrayProxy Class

An ArrayProxy wraps any other object that implements Ember.Array and/or Ember.MutableArray, forwarding all requests. This makes it very useful for a number of binding use cases or other cases where being able to swap out the underlying array is useful.

A simple example of usage:

let pets = ['dog', 'cat', 'fish'];
let ap = Ember.ArrayProxy.create({ content: Ember.A(pets) });

ap.get('firstObject');                        // 'dog'
ap.set('content', ['amoeba', 'paramecium']);
ap.get('firstObject');                        // 'amoeba'

This class can also be useful as a layer to transform the contents of an array, as they are accessed. This can be done by overriding objectAtContent:

let pets = ['dog', 'cat', 'fish'];
let ap = Ember.ArrayProxy.create({
    content: Ember.A(pets),
    objectAtContent: function(idx) {
        return this.get('content').objectAt(idx).toUpperCase();
    }
});

ap.get('firstObject'); // . 'DOG'

Methods

_contentDidChange

() private

Invoked when the content property changes. Notifies observers that the entire array content has changed.

_contentWillChange

() private

Invoked when the content property is about to change. Notifies observers that the entire array content will change.

_lazyInjections

() Object private
Returns a hash of property names and container names that injected properties will lookup on the container lazily.

Returns:

Object: Hash of all lazy injected property keys to container names

_onLookup

() private
Provides lookup-time type validation for injected properties.

_scheduledDestroy

() private
Invoked by the run loop to actually destroy the object. This is scheduled for execution by the destroy method.

addObject

(
  • obj
)
Ember.Array public

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

let cities = ['Chicago', 'Berlin'];

cities.addObject('Lima');    // ['Chicago', 'Berlin', 'Lima']
cities.addObject('Berlin');  // ['Chicago', 'Berlin', 'Lima']

Parameters:

  • obj

    object to add, if not already present

Returns:

Ember.Array:

receiver

addObserver

(
  • key
  • target
  • method
)
public

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.

Parameters:

  • key String

    The key to observer

  • target Object

    The target object to invoke

  • method String | Function

    The method to invoke.

beginPropertyChanges

() Ember.Observable private

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:

cacheFor

(
  • keyName
)
Object public

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.

Parameters:

Returns:

Object:

The cached value of the computed property, if any

clear

() Ember.Array public

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

let colors = ['red', 'green', 'blue'];

colors.length;  // 3
colors.clear(); // []
colors.length;  // 0

Returns:

Ember.Array:

An empty Array.

contentArrayDidChange

(
  • contentArray
  • start
  • removeCount
  • addCount
)
private

Override to implement content array didChange observer.

Parameters:

  • contentArray Ember.Array

    the content array

  • start Number

    starting index of the change

  • removeCount Number

    count of items removed

  • addCount Number

    count of items added

contentArrayWillChange

(
  • contentArray
  • start
  • removeCount
  • addCount
)
private

Override to implement content array willChange observer.

Parameters:

  • contentArray Ember.Array

    the content array

  • start Number

    starting index of the change

  • removeCount Number

    count of items removed

  • addCount Number

    count of items added

decrementProperty

(
  • keyName
  • decrement
)
Number public

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

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

Parameters:

  • keyName String

    The name of the property to decrement

  • decrement Number

    The amount to decrement by. Defaults to 1

Returns:

Number:

The new property value

destroy

() Ember.Object public
Destroys an object by setting the isDestroyed flag and removing its metadata, which effectively destroys observers and bindings. If you try to set a property on a destroyed object, an exception will be raised. Note that destruction is scheduled for the end of the run loop and does not happen immediately. It will set an isDestroying flag immediately.

Returns:

Ember.Object:

receiver

endPropertyChanges

() Ember.Observable private

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.

Returns:

get

(
  • keyName
)
Object public

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: Ember.computed('firstName', 'lastName', function() {
  return this.get('firstName') + ' ' + this.get('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.

Parameters:

  • keyName String

    The property to retrieve

Returns:

Object:

The property value or undefined.

getProperties

(
  • list
)
Object public

To get the values of 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' }

Parameters:

  • list String... | Array

    of keys to get

Returns:

Object:

getWithDefault

(
  • keyName
  • defaultValue
)
Object public

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

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

Parameters:

  • keyName String

    The name of the property to retrieve

  • defaultValue Object

    The value to return if the property value is undefined

Returns:

Object:

The property value or the defaultValue.

hasObserverFor

(
  • key
)
Boolean private

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.

Parameters:

Returns:

Boolean:

incrementProperty

(
  • keyName
  • increment
)
Number public

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

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

Parameters:

  • keyName String

    The name of the property to increment

  • increment Number

    The amount to increment by. Defaults to 1

Returns:

Number:

The new property value

init

() public
An overridable method called when objects are instantiated. By default, does nothing unless it is overridden during class definition. Example: `javascript const Person = Ember.Object.extend({ init() { alert(Name is ${this.get('name')}); } }); let steve = Person.create({ name: "Steve" }); // alerts 'Name is Steve'. ` NOTE: If you do override init for a framework class like Ember.View, be sure to call this._super(...arguments) in your init declaration! If you don't, Ember may not have an opportunity to do important setup work, and you'll see strange behavior in your application.

insertAt

(
  • idx
  • object
)
Ember.Array public

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

let colors = ['red', 'green', 'blue'];

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

Parameters:

  • idx Number

    index of insert the object at.

  • object Object

    object to insert

Returns:

Ember.Array:

receiver

notifyPropertyChange

(
  • keyName
)
Ember.Observable public

Convenience method to call propertyWillChange and propertyDidChange in succession.

Parameters:

  • keyName String

    The property key to be notified about.

Returns:

objectAtContent

(
  • idx
)
Object public

Should actually retrieve the object at the specified index from the content. You can override this method in subclasses to transform the content item to something new.

This method will only be called if content is non-null.

Parameters:

  • idx Number

    The index to retrieve.

Returns:

Object:

the value or undefined if none found

popObject

() public

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

let colors = ['red', 'green', 'blue'];

colors.popObject();   // 'blue'
console.log(colors);  // ['red', 'green']

Returns:

object

propertyDidChange

(
  • keyName
)
Ember.Observable private

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.

Parameters:

  • keyName String

    The property key that has just changed.

Returns:

propertyWillChange

(
  • keyName
)
Ember.Observable private

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.

Parameters:

  • keyName String

    The property key that is about to change.

Returns:

pushObject

(
  • obj
)
public

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

let colors = ['red', 'green'];

colors.pushObject('black');     // ['red', 'green', 'black']
colors.pushObject(['yellow']);  // ['red', 'green', ['yellow']]

Parameters:

  • obj

    object to push

Returns:

object same object passed as a param

pushObjects

(
  • objects
)
Ember.Array public

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

let colors = ['red'];

colors.pushObjects(['yellow', 'orange']);  // ['red', 'yellow', 'orange']

Parameters:

Returns:

Ember.Array:

receiver

removeAt

(
  • start
  • len
)
Ember.Array public

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.

let 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

Parameters:

  • start Number

    index, start of range

  • len Number

    length of passing range

Returns:

Ember.Array:

receiver

removeObject

(
  • obj
)
Ember.Array public

Remove all occurrences of an object in the array.

let cities = ['Chicago', 'Berlin', 'Lima', 'Chicago'];

cities.removeObject('Chicago');  // ['Berlin', 'Lima']
cities.removeObject('Lima');     // ['Berlin']
cities.removeObject('Tokyo')     // ['Berlin']

Parameters:

  • obj

    object to remove

Returns:

Ember.Array:

receiver

removeObserver

(
  • key
  • target
  • method
)
public

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.

Parameters:

  • key String

    The key to observer

  • target Object

    The target object to invoke

  • method String | Function

    The method to invoke.

reopen

() public
Augments a constructor's prototype with additional properties and functions: `javascript const MyObject = Ember.Object.extend({ name: 'an object' }); o = MyObject.create(); o.get('name'); // 'an object' MyObject.reopen({ say(msg){ console.log(msg); } }) o2 = MyObject.create(); o2.say("hello"); // logs "hello" o.say("goodbye"); // logs "goodbye" ` To add functions and properties to the constructor itself, see reopenClass

reopenClass

() public
Augments a constructor's own properties and functions: `javascript const MyObject = Ember.Object.extend({ name: 'an object' }); MyObject.reopenClass({ canBuild: false }); MyObject.canBuild; // false o = MyObject.create(); ` In other words, this creates static properties and functions for the class. These are only available on the class and not on any instance of that class. `javascript const Person = Ember.Object.extend({ name: "", sayHello() { alert("Hello. My name is " + this.get('name')); } }); Person.reopenClass({ species: "Homo sapiens", createPerson(newPersonsName){ return Person.create({ name:newPersonsName }); } }); let tom = Person.create({ name: "Tom Dale" }); let yehuda = Person.createPerson("Yehuda Katz"); tom.sayHello(); // "Hello. My name is Tom Dale" yehuda.sayHello(); // "Hello. My name is Yehuda Katz" alert(Person.species); // "Homo sapiens" ` Note that species and createPerson are *not* valid on the tom and yehuda variables. They are only valid on Person. To add functions and properties to instances of a constructor by extending the constructor's prototype see reopen

replace

(
  • idx
  • amt
  • objects
)
public

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()

Parameters:

  • idx Number

    Starting index in the array to replace. If idx >= length, then append to the end of the array.

  • amt Number

    Number of elements that should be removed from the array, starting at idx.

  • objects Array

    An array of zero or more objects that should be inserted into the array at idx

replaceContent

(
  • idx
  • amt
  • objects
)
Void private

Should actually replace the specified objects on the content array. You can override this method in subclasses to transform the content item into something new.

This method will only be called if content is non-null.

Parameters:

  • idx Number

    The starting index

  • amt Number

    The number of items to remove from the content.

  • objects Array

    Optional array of objects to insert or null if no objects.

Returns:

Void:

reverseObjects

() Ember.Array public

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

Returns:

Ember.Array:

receiver

set

(
  • keyName
  • value
)
Object public

Sets the provided key or path to the value.

record.set("key", 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.

Parameters:

  • keyName String

    The property to set

  • value Object

    The value to set or null.

Returns:

Object:

The passed value

setObjects

(
  • objects
)
Ember.Array public

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

let colors = ['red', 'green', 'blue'];

colors.setObjects(['black', 'white']);  // ['black', 'white']
colors.setObjects([]);                  // []

Parameters:

  • objects Ember.Array

    array whose content will be used for replacing the content of the receiver

Returns:

Ember.Array:

receiver with the new content

setProperties

(
  • hash
)
Object public

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' });

Parameters:

  • hash Object

    the hash of keys and values to set

Returns:

Object:

The passed in hash

shiftObject

() public

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

let colors = ['red', 'green', 'blue'];

colors.shiftObject();  // 'red'
console.log(colors);   // ['green', 'blue']

Returns:

object

toggleProperty

(
  • keyName
)
Boolean public

Set the value of a boolean property to the opposite of its current value.

starship.toggleProperty('warpDriveEngaged');

Parameters:

  • keyName String

    The name of the property to toggle

Returns:

Boolean:

The new property value

toString

() String public
Returns a string representation which attempts to provide more information than Javascript's toString typically does, in a generic way for all Ember objects. `javascript const Person = Ember.Object.extend() person = Person.create() person.toString() //=> "" ` If the object's class is not defined on an Ember namespace, it will indicate it is a subclass of the registered superclass: `javascript const Student = Person.extend() let student = Student.create() student.toString() //=> "<(subclass of Person):ember1025>" ` If the method toStringExtension is defined, its return value will be included in the output. `javascript const Teacher = Person.extend({ toStringExtension() { return this.get('fullName'); } }); teacher = Teacher.create() teacher.toString(); //=> "" `

Returns:

String: string representation

unshiftObject

(
  • obj
)
public

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

let colors = ['red'];

colors.unshiftObject('yellow');    // ['yellow', 'red']
colors.unshiftObject(['black']);   // [['black'], 'yellow', 'red']

Parameters:

  • obj

    object to unshift

Returns:

object same object passed as a param

unshiftObjects

(
  • objects
)
Ember.Array public

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

let colors = ['red'];

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

Parameters:

Returns:

Ember.Array:

receiver

willDestroy

() public
Override to implement teardown.

Properties

arrangedContent

Unknown private

The array that the proxy pretends to be. In the default ArrayProxy implementation, this and content are the same. Subclasses of ArrayProxy can override this property to provide things like sorting and filtering.

concatenatedProperties

Array public
Defines the properties that will be concatenated from the superclass (instead of overridden). By default, when you extend an Ember class a property defined in the subclass overrides a property with the same name that is defined in the superclass. However, there are some cases where it is preferable to build up a property's value by combining the superclass' property value with the subclass' value. An example of this in use within Ember is the classNames property of Ember.View. Here is some sample code showing the difference between a concatenated property and a normal one: `javascript const Bar = Ember.Object.extend({ // Configure which properties to concatenate concatenatedProperties: ['concatenatedProperty'], someNonConcatenatedProperty: ['bar'], concatenatedProperty: ['bar'] }); const FooBar = Bar.extend({ someNonConcatenatedProperty: ['foo'], concatenatedProperty: ['foo'] }); let fooBar = FooBar.create(); fooBar.get('someNonConcatenatedProperty'); // ['foo'] fooBar.get('concatenatedProperty'); // ['bar', 'foo'] ` This behavior extends to object creation as well. Continuing the above example: `javascript let fooBar = FooBar.create({ someNonConcatenatedProperty: ['baz'], concatenatedProperty: ['baz'] }) fooBar.get('someNonConcatenatedProperty'); // ['baz'] fooBar.get('concatenatedProperty'); // ['bar', 'foo', 'baz'] ` Adding a single property that is not an array will just add it in the array: `javascript let fooBar = FooBar.create({ concatenatedProperty: 'baz' }) view.get('concatenatedProperty'); // ['bar', 'foo', 'baz'] ` Using the concatenatedProperties property, we can tell Ember to mix the content of the properties. In Ember.Component the classNames, classNameBindings and attributeBindings properties are concatenated. This feature is available for you to use throughout the Ember object model, although typical app developers are likely to use it infrequently. Since it changes expectations about behavior of properties, you should properly document its usage in each individual concatenated property (to not mislead your users to think they can override the property in a subclass).

Default: null

content

Ember.Array private

The content array. Must be an object that implements Ember.Array and/or Ember.MutableArray.

isDestroyed

Unknown public
Destroyed object property flag. if this property is true the observers and bindings were already removed by the effect of calling the destroy() method.

Default: false

isDestroying

Unknown public
Destruction scheduled flag. The destroy() method has been called. The object stays intact until the end of the run loop at which point the isDestroyed flag is set.

Default: false

mergedProperties

Array public
Defines the properties that will be merged from the superclass (instead of overridden). By default, when you extend an Ember class a property defined in the subclass overrides a property with the same name that is defined in the superclass. However, there are some cases where it is preferable to build up a property's value by merging the superclass property value with the subclass property's value. An example of this in use within Ember is the queryParams property of routes. Here is some sample code showing the difference between a merged property and a normal one: `javascript const Bar = Ember.Object.extend({ // Configure which properties are to be merged mergedProperties: ['mergedProperty'], someNonMergedProperty: { nonMerged: 'superclass value of nonMerged' }, mergedProperty: { page: {replace: false}, limit: {replace: true} } }); const FooBar = Bar.extend({ someNonMergedProperty: { completelyNonMerged: 'subclass value of nonMerged' }, mergedProperty: { limit: {replace: false} } }); let fooBar = FooBar.create(); fooBar.get('someNonMergedProperty'); // => { completelyNonMerged: 'subclass value of nonMerged' } // // Note the entire object, including the nonMerged property of // the superclass object, has been replaced fooBar.get('mergedProperty'); // => { // page: {replace: false}, // limit: {replace: false} // } // // Note the page remains from the superclass, and the // limit property's value of false has been merged from // the subclass. ` This behavior is not available during object create calls. It is only available at extend time. In Ember.Route the queryParams property is merged. This feature is available for you to use throughout the Ember object model, although typical app developers are likely to use it infrequently. Since it changes expectations about behavior of properties, you should properly document its usage in each individual merged property (to not mislead your users to think they can override the property in a subclass).

Default: null