Ember.ArrayController Class packages/ember-runtime/lib/controllers/array_controller.js:13


Ember.ArrayController provides a way for you to publish a collection of objects so that you can easily bind to the collection from a Handlebars #each helper, an Ember.CollectionView, or other controllers.

The advantage of using an ArrayController is that you only have to set up your view bindings once; to change what's displayed, simply swap out the content property on the controller.

For example, imagine you wanted to display a list of items fetched via an XHR request. Create an Ember.ArrayController and set its content property:

1
2
3
4
5
MyApp.listController = Ember.ArrayController.create();

$.get('people.json', function(data) {
  MyApp.listController.set('content', data);
});

Then, create a view that binds to your new controller:

1
2
3
{{#each MyApp.listController}}
  {{firstName}} {{lastName}}
{{/each}}

Although you are binding to the controller, the behavior of this controller is to pass through any methods or properties to the underlying array. This capability comes from Ember.ArrayProxy, which this class inherits from.

Sometimes you want to display computed properties within the body of an #each helper that depend on the underlying items in content, but are not present on those items. To do this, set itemController to the name of a controller (probably an ObjectController) that will wrap each individual item.

For example:

1
2
3
  {{#each post in controller}}
    <li>{{title}} ({{titleLength}} characters)</li>
  {{/each}}
1
2
3
4
5
6
7
8
9
10
11
App.PostsController = Ember.ArrayController.extend({
  itemController: 'post'
});

App.PostController = Ember.ObjectController.extend({
  // the `title` property will be proxied to the underlying post.

  titleLength: function() {
    return this.get('title').length;
  }.property('title')
});

In some cases it is helpful to return a different itemController depending on the particular item. Subclasses can do this by overriding lookupItemController.

For example:

1
2
3
4
5
6
7
8
9
App.MyArrayController = Ember.ArrayController.extend({
  lookupItemController: function( object ) {
    if (object.get('isSpecial')) {
      return "special"; // use App.SpecialController
    } else {
      return "regular"; // use App.RegularController
    }
  }
});

The itemController instances will have a parentController property set to either the the parentController property of the ArrayController or to the ArrayController instance itself.

Show:

Methods

Properties

Show:

_contentDidChange

private

_contentWillChange

private

_scheduledDestroy

private

addArrayObserver

(target, opts) Ember.Array

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.

Parameters:

target Object
The observer object.
opts Hash
Optional hash of configuration options including `willChange` and `didChange` option.

Returns:

Ember.Array
receiver

addEnumerableObserver

(target, opts)

Registers an enumerable observer. Must implement Ember.EnumerableObserver mixin.

Parameters:

target Object
opts Hash

Returns:

this

addObject

(object) Object

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

Attempts to add the passed object to the receiver if the object is not already present in the collection. If the object is present, this method has no effect.

If the passed object is of a type not supported by the receiver, then this method should raise an exception.

Parameters:

object Object
The object to add to the enumerable.

Returns:

Object
the passed object

addObjects

(objects) Object

Adds each object in the passed enumerable to the receiver.

Parameters:

objects Ember.Enumerable
the objects to add.

Returns:

Object
receiver

addObserver

(key, target, method) Ember.Object

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:

1
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:

1
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.

Returns:

Ember.Object
self

any

(callback, target) Boolean

Returns true if the passed function returns true for any item in the enumeration. This corresponds with the some() method in JavaScript 1.6.

The callback method you provide should have the following signature (all parameters are optional):

1
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 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.

Usage Example:

1
if (people.any(isManager)) { Paychecks.addBiggerBonus(); }

Parameters:

callback Function
The callback to execute
target Object
The target object to use

Returns:

Boolean
`true` if the passed function returns `true` for any item

anyBy

(key, value) Boolean

Returns true if the passed property resolves to true for any item in the enumerable. This method is often simpler/faster than using a callback.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Boolean
`true` if the passed function returns `true` for any item

arrayContentDidChange

(startIdx, removeAmt, addAmt) Ember.Array

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.

Parameters:

startIdx Number
The starting index in the array that did change.
removeAmt Number
The number of items that were removed. If you pass `null` assumes 0
addAmt Number
The number of items that were added. If you pass `null` assumes 0.

Returns:

Ember.Array
receiver

arrayContentWillChange

(startIdx, removeAmt, addAmt) Ember.Array

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.

Parameters:

startIdx Number
The starting index in the array that will change.
removeAmt Number
The number of items that will be removed. If you pass `null` assumes 0
addAmt Number
The number of items that will be added. If you pass `null` assumes 0.

Returns:

Ember.Array
receiver

beginPropertyChanges

Ember.Observable

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:

Ember.Observable

cacheFor

(keyName) Object

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:

keyName String

Returns:

Object
The cached value of the computed property, if any

child

Container

Returns a new child of the current container. These children are configured to correctly inherit from the current container.

Returns:

Container

clear

Ember.Array

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

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

Returns:

Ember.Array
An empty Array.

compact

Array

Returns a copy of the array with all null and undefined elements removed.

1
2
var arr = ["a", null, "c", undefined];
arr.compact();  // ["a", "c"]

Returns:

Array
the array without null and undefined elements.

contains

(obj) Boolean

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.

1
2
3
var arr = ["a", "b", "c"];
arr.contains("a"); // true
arr.contains("z"); // false

Parameters:

obj Object
The object to search for.

Returns:

Boolean
`true` if object is found in enumerable.

controllerFor

deprecated

create

(arguments) static

Creates an instance of a class. Accepts either no arguments, or an object containing values to initialize the newly instantiated object with.

1
2
3
4
5
6
7
8
9
10
11
App.Person = Ember.Object.extend({
  helloWorld: function() {
    alert("Hi, my name is " + this.get('name'));
  }
});

var tom = App.Person.create({
  name: 'Tom Dale'
});

tom.helloWorld(); // alerts "Hi, my name is Tom Dale".

create will call the init function if defined during Ember.AnyObject.extend

If no arguments are passed to create, it will not set values to the new instance during initialization:

1
2
var noName = App.Person.create();
noName.helloWorld(); // alerts undefined

NOTE: For performance reasons, you cannot declare methods or computed properties during create. You should instead declare methods and computed properties when using extend or use the createWithMixins shorthand.

Parameters:

arguments

createWithMixins

(arguments) static

Equivalent to doing extend(arguments).create(). If possible use the normal create method instead.

Parameters:

arguments

decrementProperty

(keyName, decrement) Number

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

1
2
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

describe

A hook that can be used to describe how the resolver will attempt to find the factory.

For example, the default Ember .describe returns the full class name (including namespace) where Ember's resolver expects to find the fullName.

destroy

Inherited from Ember.CoreObject but overwritten in packages/container/lib/main.js:695

A depth first traversal, destroying the container, its descendant containers and all their managed objects.

eachComputedProperty

(callback, binding)

Iterate over each computed property for the class, passing its name and any associated metadata (see metaForProperty) to the callback.

Parameters:

callback Function
binding Object

eachLocal

(callback, binding)

Iterate and invoke a callback for each local key-value pair.

Parameters:

callback Function
binding Object

endPropertyChanges

Ember.Observable

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:

Ember.Observable

enumerableContentDidChange

(start, removing, adding)

Invoke this method when the contents of your enumerable has changed. This will notify any observers watching for content changes. If your are implementing an ordered enumerable (such as an array), also pass the start and end values where the content changed so that it can be used to notify range observers.

Parameters:

start Number
optional start offset for the content change. For unordered enumerables, you should always pass -1.
removing Ember.Enumerable|Number
An enumerable of the objects to be removed or the number of items to be removed.
adding Ember.Enumerable|Number
An enumerable of the objects to be added or the number of items to be added.

enumerableContentWillChange

(removing, adding)

Invoke this method just before the contents of your enumerable will change. You can either omit the parameters completely or pass the objects to be removed or added if available or just a count.

Parameters:

removing Ember.Enumerable|Number
An enumerable of the objects to be removed or the number of items to be removed.
adding Ember.Enumerable|Number
An enumerable of the objects to be added or the number of items to be added.

every

(callback, target) 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):

1
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 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:

1
if (people.every(isEngineer)) { Paychecks.addBigBonus(); }

Parameters:

callback Function
The callback to execute
target Object
The target object to use

Returns:

Boolean

everyBy

(key, value) Boolean

Returns true if the passed property resolves to true for all items in the enumerable. This method is often simpler/faster than using a callback.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Boolean

everyProperty

(key, value) Boolean deprecated

Returns true if the passed property resolves to true for all items in the enumerable. This method is often simpler/faster than using a callback.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Boolean

extend

(mixins, arguments) static

Creates a new subclass.

1
2
3
4
5
App.Person = Ember.Object.extend({
  say: function(thing) {
    alert(thing);
   }
});

This defines a new subclass of Ember.Object: App.Person. It contains one method: say().

You can also create a subclass from any existing class by calling its extend() method. For example, you might want to create a subclass of Ember's built-in Ember.View class:

1
2
3
4
App.PersonView = Ember.View.extend({
  tagName: 'li',
  classNameBindings: ['isAdministrator']
});

When defining a subclass, you can override methods but still access the implementation of your parent class by calling the special _super() method:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
App.Person = Ember.Object.extend({
  say: function(thing) {
    var name = this.get('name');
    alert(name + ' says: ' + thing);
  }
});

App.Soldier = App.Person.extend({
  say: function(thing) {
    this._super(thing + ", sir!");
  },
  march: function(numberOfHours) {
    alert(this.get('name') + ' marches for ' + numberOfHours + ' hours.')
  }
});

var yehuda = App.Soldier.create({
  name: "Yehuda Katz"
});

yehuda.say("Yes");  // alerts "Yehuda Katz says: Yes, sir!"

The create() on line #17 creates an instance of the App.Soldier class. The extend() on line #8 creates a subclass of App.Person. Any instance of the App.Person class will not have the march() method.

You can also pass Ember.Mixin classes to add additional properties to the subclass.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
App.Person = Ember.Object.extend({
  say: function(thing) {
    alert(this.get('name') + ' says: ' + thing);
  }
});

App.SingingMixin = Ember.Mixin.create({
  sing: function(thing){
    alert(this.get('name') + ' sings: la la la ' + thing);
  }
});

App.BroadwayStar = App.Person.extend(App.SingingMixin, {
  dance: function() {
    alert(this.get('name') + ' dances: tap tap tap tap ');
  }
});

The App.BroadwayStar class contains three methods: say(), sing(), and dance().

Parameters:

mixins Ember.Mixin
One or more Ember.Mixin classes
arguments Object
Object containing values to use within the new class

factoryInjection

(factoryName, property, injectionName)

Defines factory injection rules.

Similar to regular injection rules, but are run against factories, via Container#lookupFactory.

These rules are used to inject objects onto factories when they are looked up.

Two forms of injections are possible:

1
2
  * Injecting one fullName on another fullName
  * Injecting one fullName on a type

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
var container = new Container();

container.register('store:main', Store);
container.register('store:secondary', OtherStore);
container.register('model:user', User);
container.register('model:post', Post);

// injecting one fullName on another type
container.factoryInjection('model', 'store', 'store:main');

// injecting one fullName on another fullName
container.factoryInjection('model:post', 'secondaryStore', 'store:secondary');

var UserFactory = container.lookupFactory('model:user');
var PostFactory = container.lookupFactory('model:post');
var store = container.lookup('store:main');

UserFactory.store instanceof Store; //=> true
UserFactory.secondaryStore instanceof OtherStore; //=> false

PostFactory.store instanceof Store; //=> true
PostFactory.secondaryStore instanceof OtherStore; //=> true

// and both models share the same source instance
UserFactory.store === PostFactory.store; //=> true

Parameters:

factoryName String
property String
injectionName String

factoryTypeInjection

(type, property, fullName) private

Parameters:

type String
property String
fullName String

filter

(callback, target) 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):

1
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 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.

Parameters:

callback Function
The callback to execute
target Object
The target object to use

Returns:

Array
A filtered array.

filterBy

(key, value) 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.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Array
filtered array

filterProperty

(key, value) Array deprecated

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.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Array
filtered array

find

(callback, target) Object

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

1
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 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.

Parameters:

callback Function
The callback to execute
target Object
The target object to use

Returns:

Object
Found item or `undefined`.

findBy

(key, value) Object

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.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Object
found item or `undefined`

findProperty

(key, value) Object deprecated

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.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Object
found item or `undefined`

forEach

(callback, target) Object

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

1
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.

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.

Parameters:

callback Function
The callback to execute
target Object
The target object to use

Returns:

Object
receiver

get

Any
Inherited from Ember.Observable but overwritten in packages/container/lib/main.js:44

Retrieve the value given a key, if the value is present at the current level use it, otherwise walk up the parent hierarchy and try again. If no matching key is found, return undefined.

Returns:

Any

getEach

(key) Array

Alias for mapBy

Parameters:

key String
name of the property

Returns:

Array
The mapped array.

getProperties

(list) Hash

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

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

is equivalent to:

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

Parameters:

list String...|Array
of keys to get

Returns:

Hash

getWithDefault

(keyName, defaultValue) Object

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

1
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.

has

(fullName) Boolean
Inherited from Ember.ControllerMixin but overwritten in packages/container/lib/main.js:444

Given a fullName check if the container is aware of its factory or singleton instance.

Parameters:

fullName String

Returns:

Boolean

hasObserverFor

(key) Boolean

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:

key String
Key to check

Returns:

Boolean

incrementProperty

(keyName, increment) Number

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

1
2
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

indexOf

(object, startAt) Number

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.

1
2
3
4
5
6
7
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);  // -1

Parameters:

object Object
the item to search for
startAt Number
optional starting location to search, default 0

Returns:

Number
index or -1 if not found

init

An overridable method called when objects are instantiated. By default, does nothing unless it is overridden during class definition.

Example:

1
2
3
4
5
6
7
8
9
10
11
App.Person = Ember.Object.extend({
  init: function() {
    alert('Name is ' + this.get('name'));
  }
});

var steve = App.Person.create({
  name: "Steve"
});

// alerts 'Name is Steve'.

NOTE: If you do override init for a framework class like Ember.View or Ember.ArrayController, be sure to call this._super() 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.

injection

(factoryName, property, injectionName)

Defines injection rules.

These rules are used to inject dependencies onto objects when they are instantiated.

Two forms of injections are possible:

1
2
  * Injecting one fullName on another fullName
  * Injecting one fullName on a type

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
var container = new Container();

container.register('source:main', Source);
container.register('model:user', User);
container.register('model:post', Post);

// injecting one fullName on another fullName
// eg. each user model gets a post model
container.injection('model:user', 'post', 'model:post');

// injecting one fullName on another type
container.injection('model', 'source', 'source:main');

var user = container.lookup('model:user');
var post = container.lookup('model:post');

user.source instanceof Source; //=> true
post.source instanceof Source; //=> true

user.post instanceof Post; //=> true

// and both models share the same source
user.source === post.source; //=> true

Parameters:

factoryName String
property String
injectionName String

insertAt

(idx, object)

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

1
2
3
var 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:

this

invoke

(methodName, args) Array

Invokes the named method on every object in the receiver that implements it. This method corresponds to the implementation in Prototype 1.6.

Parameters:

methodName String
the name of the method
args Object...
optional arguments to pass as well.

Returns:

Array
return values from calling invoke.

lastIndexOf

(object, startAt) Number

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.

1
2
3
4
5
6
7
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);  //  4

Parameters:

object Object
the item to search for
startAt Number
optional starting location to search, default 0

Returns:

Number
index or -1 if not found

lookup

(fullName, options) Any

Given a fullName return a corresponding instance.

The default behaviour is for lookup to return a singleton instance. The singleton is scoped to the container, allowing multiple containers to all have their own locally scoped singletons.

1
2
3
4
5
6
7
8
9
10
11
12
var container = new Container();
container.register('api:twitter', Twitter);

var twitter = container.lookup('api:twitter');

twitter instanceof Twitter; // => true

// by default the container will return singletons
twitter2 = container.lookup('api:twitter');
twitter instanceof Twitter; // => true

twitter === twitter2; //=> true

If singletons are not wanted an optional flag can be provided at lookup.

1
2
3
4
5
6
7
var container = new Container();
container.register('api:twitter', Twitter);

var twitter = container.lookup('api:twitter', { singleton: false });
var twitter2 = container.lookup('api:twitter', { singleton: false });

twitter === twitter2; //=> false

Parameters:

fullName String
options Object

Returns:

Any

lookupFactory

(fullName) Any

Given a fullName return the corresponding factory.

Parameters:

fullName String

Returns:

Any

lookupItemController

(object) String

Return the name of the controller to wrap items, or null if items should be returned directly. The default implementation simply returns the itemController property, but subclasses can override this method to return different controllers for different objects.

For example:

1
2
3
4
5
6
7
8
9
App.MyArrayController = Ember.ArrayController.extend({
  lookupItemController: function( object ) {
    if (object.get('isSpecial')) {
      return "special"; // use App.SpecialController
    } else {
      return "regular"; // use App.RegularController
    }
  }
});

Parameters:

object Object

Returns:

String

makeToString

(factory, fullName) Function

Parameters:

factory Any
fullName String

Returns:

Function
toString function

map

(callback, target) 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):

1
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 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.

Parameters:

callback Function
The callback to execute
target Object
The target object to use

Returns:

Array
The mapped array.

mapBy

(key) Array

Similar to map, this specialized function returns the value of the named property on all items in the enumeration.

Parameters:

key String
name of the property

Returns:

Array
The mapped array.

mapProperty

(key) Array deprecated

Similar to map, this specialized function returns the value of the named property on all items in the enumeration.

Parameters:

key String
name of the property

Returns:

Array
The mapped array.

metaForProperty

(key)

In some cases, you may want to annotate computed properties with additional metadata about how they function or what values they operate on. For example, computed property functions may close over variables that are then no longer available for introspection.

You can pass a hash of these values to a computed property like this:

1
2
3
4
person: function() {
  var personId = this.get('personId');
  return App.Person.create({ id: personId });
}.property().meta({ type: App.Person })

Once you've done this, you can retrieve the values saved to the computed property from your class like this:

1
MyClass.metaForProperty('person');

This will return the original hash that was passed to meta().

Parameters:

key String
property name

nextObject

(index, previousObject, context) Object

Implement this method to make your class enumerable.

This method will be call repeatedly during enumeration. The index value will always begin with 0 and increment monotonically. You don't have to rely on the index value to determine what object to return, but you should always check the value and start from the beginning when you see the requested index is 0.

The previousObject is the object that was returned from the last call to nextObject for the current iteration. This is a useful way to manage iteration if you are tracing a linked list, for example.

Finally the context parameter will always contain a hash you can use as a "scratchpad" to maintain any other state you need in order to iterate properly. The context object is reused and is not reset between iterations so make sure you setup the context with a fresh state whenever the index parameter is 0.

Generally iterators will continue to call nextObject until the index reaches the your current length-1. If you run out of data before this time for some reason, you should simply return undefined.

The default implementation of this method simply looks up the index. This works great on any Array-like objects.

Parameters:

index Number
the current index of the iteration
previousObject Object
the value returned by the last call to `nextObject`.
context Object
a context object you can use to maintain state.

Returns:

Object
the next object in the iteration or undefined

normalize

(fullName) String

A hook to enable custom fullName normalization behaviour

Parameters:

fullName String

Returns:

String
normalized fullName

notifyPropertyChange

(keyName) Ember.Observable

Convenience method to call propertyWillChange and propertyDidChange in succession.

Parameters:

keyName String
The property key to be notified about.

Returns:

Ember.Observable

objectAt

(idx) *

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.

1
2
3
4
5
6
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);   // undefined

Parameters:

idx Number
The index of the item to return.

Returns:

*
item at index or undefined

objectAtContent

(idx) Object

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

objectsAt

(indexes) Array

This returns the objects at the specified indexes, using objectAt.

1
2
3
var arr = ['a', 'b', 'c', 'd'];
arr.objectsAt([0, 1, 2]);  // ["a", "b", "c"]
arr.objectsAt([2, 3, 4]);  // ["c", "d", undefined]

Parameters:

indexes Array
An array of indexes of items to return.

Returns:

Array

options

(type, options)

Parameters:

type String
options Object

optionsForType

(type, options)

Allow registering options for all factories of a type.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
var container = new Container();

// if all of type `connection` must not be singletons
container.optionsForType('connection', { singleton: false });

container.register('connection:twitter', TwitterConnection);
container.register('connection:facebook', FacebookConnection);

var twitter = container.lookup('connection:twitter');
var twitter2 = container.lookup('connection:twitter');

twitter === twitter2; // => false

var facebook = container.lookup('connection:facebook');
var facebook2 = container.lookup('connection:facebook');

facebook === facebook2; // => false

Parameters:

type String
options Object

popObject

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

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

Returns:

object

propertyDidChange

(keyName) Ember.Observable

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:

Ember.Observable

propertyWillChange

(keyName) Ember.Observable

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:

Ember.Observable

pushObject

(obj) *

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

1
2
3
var colors = ["red", "green", "blue"];
colors.pushObject("black");               // ["red", "green", "blue", "black"]
colors.pushObject(["yellow", "orange"]);  // ["red", "green", "blue", "black", ["yellow", "orange"]]

Parameters:

obj *
object to push

Returns:

*
the same obj passed as param

pushObjects

(objects) Ember.Array

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

1
2
3
var colors = ["red", "green", "blue"];
colors.pushObjects(["black"]);               // ["red", "green", "blue", "black"]
colors.pushObjects(["yellow", "orange"]);  // ["red", "green", "blue", "black", "yellow", "orange"]

Parameters:

objects Ember.Enumerable
the objects to add

Returns:

Ember.Array
receiver

reduce

(callback, initialValue, reducerProperty) Object

This will combine the values of the enumerator into a single value. It is a useful way to collect a summary value from an enumeration. This corresponds to the reduce() method defined in JavaScript 1.8.

The callback method you provide should have the following signature (all parameters are optional):

1
function(previousValue, item, index, enumerable);
  • previousValue is the value returned by the last call to the iterator.
  • item is the current item in the iteration.
  • index is the current index in the iteration.
  • enumerable is the enumerable object itself.

Return the new cumulative value.

In addition to the callback you can also pass an initialValue. An error will be raised if you do not pass an initial value and the enumerator is empty.

Note that unlike the other methods, this method does not allow you to pass a target object to set as this for the callback. It's part of the spec. Sorry.

Parameters:

callback Function
The callback to execute
initialValue Object
Initial value for the reduce
reducerProperty String
internal use only.

Returns:

Object
The reduced value.

register

(fullName, factory, options)

Registers a factory for later injection.

Example:

1
2
3
4
5
var container = new Container();

container.register('model:user', Person, {singleton: false });
container.register('fruit:favorite', Orange);
container.register('communication:main', Email, {singleton: false});

Parameters:

fullName String
factory Function
options Object

reject

(callback, target) Array

Returns an array with all of the items in the enumeration where the passed function returns false for. This method is the inverse of filter().

The callback method you provide should have the following signature (all parameters are optional):

1
  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 the 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.

Parameters:

callback Function
The callback to execute
target Object
The target object to use

Returns:

Array
A rejected array.

rejectBy

(key, value) 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.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Array
rejected array

rejectProperty

(key, value) Array deprecated

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.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Array
rejected array

remove

(key)

Delete the given key

Parameters:

key String

removeArrayObserver

(target, opts) Ember.Array

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.

Parameters:

target Object
The object observing the array.
opts Hash
Optional hash of configuration options including `willChange` and `didChange` option.

Returns:

Ember.Array
receiver

removeAt

(start, len) Object

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

1
2
3
4
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

Parameters:

start Number
index, start of range
len Number
length of passing range

Returns:

Object
receiver

removeEnumerableObserver

(target, opts)

Removes a registered enumerable observer.

Parameters:

target Object
opts Hash

Returns:

this

removeObject

(object) Object

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

Attempts to remove the passed object from the receiver collection if the object is present in the collection. If the object is not present, this method has no effect.

If the passed object is of a type not supported by the receiver, then this method should raise an exception.

Parameters:

object Object
The object to remove from the enumerable.

Returns:

Object
the passed object

removeObjects

(objects) Object

Removes each object in the passed enumerable from the receiver.

Parameters:

objects Ember.Enumerable
the objects to remove

Returns:

Object
receiver

removeObserver

(key, target, method) Ember.Observable

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.

Returns:

Ember.Observable
receiver

reopen

Augments a constructor's prototype with additional properties and functions: javascript MyObject = Ember.Object.extend({ name: 'an object' }); o = MyObject.create(); o.get('name'); // 'an object' MyObject.reopen({ say: function(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

Augments a constructor's own properties and functions:

1
2
3
4
5
6
7
8
9
10
11
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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
App.Person = Ember.Object.extend({
  name : "",
  sayHello : function(){
    alert("Hello. My name is " + this.get('name'));
  }
});

App.Person.reopenClass({
  species : "Homo sapiens",
  createPerson: function(newPersonsName){
    return App.Person.create({
      name:newPersonsName
    });
  }
});

var tom = App.Person.create({
  name : "Tom Dale"
});
var yehuda = App.Person.createPerson("Yehuda Katz");

tom.sayHello(); // "Hello. My name is Tom Dale"
yehuda.sayHello(); // "Hello. My name is Yehuda Katz"
alert(App.Person.species); // "Homo sapiens"

Note that species and createPerson are not valid on the tom and yehuda variables. They are only valid on App.Person.

To add functions and properties to instances of a constructor by extending the constructor's prototype see reopen

replace

(idx, amt, objects)

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

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

replaceRoute

(name, models)

Transition into another route while replacing the current URL, if possible. This will replace the current history entry instead of adding a new one. Beside that, it is identical to transitionToRoute in all other respects.

1
2
  aController.replaceRoute('blogPosts');
  aController.replaceRoute('blogPosts.recentEntries');

Optionally supply a model for the route in question. The model will be serialized into the URL using the serialize hook of the route:

1
  aController.replaceRoute('blogPost', aPost);

Multiple models will be applied last to first recursively up the resource tree.

1
2
3
4
5
6
  this.resource('blogPost', {path:':blogPostId'}, function(){
    this.resource('blogComment', {path: ':blogCommentId'});
  });

  aController.replaceRoute('blogComment', aPost, aComment);

Parameters:

name String
the name of the route
models ...Object
the model(s) to be used while transitioning to the route.

replaceWith

deprecated

reset

resolve

(fullName) Function

Given a fullName return the corresponding factory.

By default resolve will retrieve the factory from its container's registry.

1
2
3
4
var container = new Container();
container.register('api:twitter', Twitter);

container.resolve('api:twitter') // => Twitter

Optionally the container can be provided with a custom resolver. If provided, resolve will first provide the custom resolver the oppertunity to resolve the fullName, otherwise it will fallback to the registry.

1
2
3
4
5
6
7
var container = new Container();
container.resolver = function(fullName) {
  // lookup via the module system of choice
};

// the twitter factory is added to the module system
container.resolve('api:twitter') // => Twitter

Parameters:

fullName String

Returns:

Function
fullName's factory

reverseObjects

Ember.Array

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

Returns:

Ember.Array
receiver

set

(object, key, value)
Inherited from Ember.Observable but overwritten in packages/container/lib/main.js:226

Sets a key-value pair on the current container. If a parent container, has the same key, once set on a child, the parent and child will diverge as expected.

Parameters:

object Object
key String
value Any

setEach

(key, value) Object

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.

Parameters:

key String
The key to set
value Object
The object to set

Returns:

Object
receiver

setObjects

(objects) Ember.Array

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

1
2
3
var 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) Ember.Observable

To set multiple properties at once, call setProperties with a Hash:

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

Parameters:

hash Hash
the hash of keys and values to set

Returns:

Ember.Observable

shiftObject

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

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

Returns:

object

slice

(beginIndex, endIndex) Array

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.

1
2
3
4
var arr = ['red', 'green', 'blue'];
arr.slice(0);       // ['red', 'green', 'blue']
arr.slice(0, 2);    // ['red', 'green']
arr.slice(1, 100);  // ['green', 'blue']

Parameters:

beginIndex Integer
(Optional) index to begin slicing from.
endIndex Integer
(Optional) index to end the slice at.

Returns:

Array
New array with specified slice

some

(callback, target) Boolean deprecated

Returns true if the passed function returns true for any item in the enumeration. This corresponds with the some() method in JavaScript 1.6.

The callback method you provide should have the following signature (all parameters are optional):

1
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 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.

Usage Example:

1
if (people.some(isManager)) { Paychecks.addBiggerBonus(); }

Parameters:

callback Function
The callback to execute
target Object
The target object to use

Returns:

Boolean
`true` if the passed function returns `true` for any item

someProperty

(key, value) Boolean deprecated

Returns true if the passed property resolves to true for any item in the enumerable. This method is often simpler/faster than using a callback.

Parameters:

key String
the property to test
value String
optional value to test against.

Returns:

Boolean
`true` if the passed function returns `true` for any item

sortBy

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

Parameters:

property String
name(s) to sort on

Returns:

Array
The sorted array.

toArray

Array

Simply converts the enumerable into a genuine array. The order is not guaranteed. Corresponds to the method implemented by Prototype.

Returns:

Array
the enumerable as an array.

toString

String

Returns a string representation which attempts to provide more information than Javascript's toString typically does, in a generic way for all Ember objects.

1
2
3
App.Person = Em.Object.extend()
person = App.Person.create()
person.toString() //=> "<App.Person:ember1024>"

If the object's class is not defined on an Ember namespace, it will indicate it is a subclass of the registered superclass:

1
2
3
Student = App.Person.extend()
student = Student.create()
student.toString() //=> "<(subclass of App.Person):ember1025>"

If the method toStringExtension is defined, its return value will be included in the output.

1
2
3
4
5
6
7
App.Teacher = App.Person.extend({
  toStringExtension: function() {
    return this.get('fullName');
  }
});
teacher = App.Teacher.create()
teacher.toString(); //=> "<App.Teacher:ember1026:Tom Dale>"

Returns:

String
string representation

toggleProperty

(keyName) Object

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

1
starship.toggleProperty('warpDriveEngaged');

Parameters:

keyName String
The name of the property to toggle

Returns:

Object
The new property value

transitionTo

deprecated

transitionToRoute

(name, models)

Transition the application into another route. The route may be either a single route or route path:

1
2
  aController.transitionToRoute('blogPosts');
  aController.transitionToRoute('blogPosts.recentEntries');

Optionally supply a model for the route in question. The model will be serialized into the URL using the serialize hook of the route:

1
  aController.transitionToRoute('blogPost', aPost);

Multiple models will be applied last to first recursively up the resource tree.

1
2
3
4
5
6
  this.resource('blogPost', {path:':blogPostId'}, function(){
    this.resource('blogComment', {path: ':blogCommentId'});
  });

  aController.transitionToRoute('blogComment', aPost, aComment);

See also 'replaceRoute'.

Parameters:

name String
the name of the route
models ...Object
the model(s) to be used while transitioning to the route.

typeInjection

(type, property, fullName) private

Parameters:

type String
property String
fullName String

uniq

Ember.Enumerable

Returns a new enumerable that contains only unique values. The default implementation returns an array regardless of the receiver type.

1
2
var arr = ["a", "a", "b", "b"];
arr.uniq();  // ["a", "b"]

Returns:

Ember.Enumerable

unregister

(fullName)

Unregister a fullName

1
2
3
4
5
6
7
var container = new Container();
container.register('model:user', User);

container.lookup('model:user') instanceof User //=> true

container.unregister('model:user')
container.lookup('model:user') === undefined //=> true

Parameters:

fullName String

unshiftObject

(obj) *

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

1
2
3
var colors = ["red", "green", "blue"];
colors.unshiftObject("yellow");             // ["yellow", "red", "green", "blue"]
colors.unshiftObject(["black", "white"]);   // [["black", "white"], "yellow", "red", "green", "blue"]

Parameters:

obj *
object to unshift

Returns:

*
the same obj passed as param

unshiftObjects

(objects) Ember.Array

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

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

Parameters:

objects Ember.Enumerable
the objects to add

Returns:

Ember.Array
receiver

willDestroy

Override to implement teardown.

without

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

1
2
var arr = ["a", "b", "a", "c"];
arr.without("a");  // ["b", "c"]

Parameters:

value Object

Returns:

Ember.Enumerable
Show:

@each

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.

Boolean

Becomes true whenever the array currently has observers watching changes on the array.

[]

Ember.Array

This property will trigger anytime the enumerable's content changes. You can observe this property to be notified of changes to the enumerables content.

For plain enumerables, this property is read only. Ember.Array overrides this method.

Returns:

this

_options

InheritingDict private

Default: null

_typeOptions

InheritingDict private

arrangedContent

Overrides the default arrangedContent from arrayProxy in order to sort by sortFunction. Also sets up observers for each sortProperty on each item in the content Array.

cache

InheritingDict

children

Array

Default: []

concatenatedProperties

Array

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:

1
2
3
4
5
6
7
8
9
10
11
12
13
App.BarView = Ember.View.extend({
  someNonConcatenatedProperty: ['bar'],
  classNames: ['bar']
});

App.FooBarView = App.BarView.extend({
  someNonConcatenatedProperty: ['foo'],
  classNames: ['foo'],
});

var fooBarView = App.FooBarView.create();
fooBarView.get('someNonConcatenatedProperty'); // ['foo']
fooBarView.get('classNames'); // ['ember-view', 'bar', 'foo']

This behavior extends to object creation as well. Continuing the above example:

1
2
3
4
5
6
var view = App.FooBarView.create({
  someNonConcatenatedProperty: ['baz'],
  classNames: ['baz']
})
view.get('someNonConcatenatedProperty'); // ['baz']
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']

Adding a single property that is not an array will just add it in the array:

1
2
3
4
var view = App.FooBarView.create({
  classNames: 'baz'
})
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']

Using the concatenatedProperties property, we can tell to Ember that mix the content of the properties.

In Ember.View the classNameBindings and attributeBindings properties are also concatenated, in addition to classNames.

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

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

controllers

Object

Stores the instances of other controllers available from within this controller. Any controller listed by name in the needs property will be accessible by name through this property.

1
2
3
4
5
6
7
App.CommentsController = Ember.ArrayController.extend({
  needs: ['post'],
  postTitle: function(){
    var currentPost = this.get('controllers.post'); // instance of App.PostController
    return currentPost.get('title');
  }.property('controllers.post.title')
});

Default: null

dict

Object

Object used to store the current nodes data.

Default: Object

firstObject

Object

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.

1
2
3
4
5
var arr = ["a", "b", "c"];
arr.get('firstObject');  // "a"

var arr = [];
arr.get('firstObject');  // undefined

Returns:

Object
the object or undefined

hasEnumerableObservers

Boolean

Becomes true whenever the array currently has observers watching changes on the array.

injections

Object

Default: {}

isDestroyed

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

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

itemController

String

The controller used to wrap items, if any.

Default: null

lastObject

Object

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.

1
2
3
4
5
var arr = ["a", "b", "c"];
arr.get('lastObject');  // "c"

var arr = [];
arr.get('lastObject');  // undefined

Returns:

Object
the last object or undefined

length

Number

Your array must support the length property. Your replace methods should set this property whenever it changes.

needs

Array

An array of other controller objects available inside instances of this controller via the controllers property:

For example, when you define a controller:

1
2
3
App.CommentsController = Ember.ArrayController.extend({
  needs: ['post']
});

The application's single instance of these other controllers are accessible by name through the controllers property:

1
this.get('controllers.post'); // instance of App.PostController

This is only available for singleton controllers.

Default: []

parent

Container
Inherited from Ember.ControllerMixin but overwritten in packages/container/lib/main.js:151

Default: null

registry

InheritingDict

resolver

function

sortAscending

Boolean

Specifies the arrangedContent's sort direction

sortFunction

{Function}

The function used to compare two values. You can override this if you want to do custom comparisons. Functions must be of the type expected by Array#sort, i.e. return 0 if the two parameters are equal, return a negative value if the first parameter is smaller than the second or return a positive value otherwise:

1
2
3
4
5
function(x,y) { // These are assumed to be integers
  if (x === y)
    return 0;
  return x < y ? -1 : 1;
}

Default: Ember.compare

sortProperties

Array

Specifies which properties dictate the arrangedContent's sort order.

When specifying multiple properties the sorting will use properties from the sortProperties array prioritized from first to last.

target

The object to which actions from the view should be sent.

For example, when a Handlebars template uses the {{action}} helper, it will attempt to send the action to the view's controller's target.

By default, a controller's target is set to the router after it is instantiated by Ember.Application#initialize.

Default: null

typeInjections

InheritingDict