Ember.SortableMixin Class packages/ember-runtime/lib/mixins/sortable.js:8


Ember.SortableMixin provides a standard interface for array proxies to specify a sort order and maintain this sorting when objects are added, removed, or updated without changing the implicit order of their underlying content array:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
songs = [
  {trackNumber: 4, title: 'Ob-La-Di, Ob-La-Da'},
  {trackNumber: 2, title: 'Back in the U.S.S.R.'},
  {trackNumber: 3, title: 'Glass Onion'},
];

songsController = Ember.ArrayController.create({
  content: songs,
  sortProperties: ['trackNumber'],
  sortAscending: true
});

songsController.get('firstObject');  // {trackNumber: 2, title: 'Back in the U.S.S.R.'}

songsController.addObject({trackNumber: 1, title: 'Dear Prudence'});
songsController.get('firstObject');  // {trackNumber: 1, title: 'Dear Prudence'}

If you add or remove the properties to sort by or change the sort direction the content sort order will be automatically updated.

1
2
3
4
5
songsController.set('sortProperties', ['title']);
songsController.get('firstObject'); // {trackNumber: 2, title: 'Back in the U.S.S.R.'}

songsController.toggleProperty('sortAscending');
songsController.get('firstObject'); // {trackNumber: 4, title: 'Ob-La-Di, Ob-La-Da'}

SortableMixin works by sorting the arrangedContent array, which is the array that arrayProxy displays. Due to the fact that the underlying 'content' array is not changed, that array will not display the sorted list:

1
2
songsController.get('content').get('firstObject'); // Returns the unsorted original content
songsController.get('firstObject'); // Returns the sorted content.

Although the sorted content can also be accessed through the arrangedContent property, it is preferable to use the proxied class and not the arrangedContent array directly.

Show:

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

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 deprecated

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

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.

enumerableContentDidChange

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

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 deprecated

Parameters:

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

Returns:

Boolean

everyProperty

(key, value) Boolean deprecated

Parameters:

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

Returns:

Boolean

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 *
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

getEach

(key) Array

Alias for mapBy

Parameters:

key String
name of the property

Returns:

Array
The mapped array.

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.

isAny

(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

isEvery

(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

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.

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

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.

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

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

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

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

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.

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

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:

[]

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

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.

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.

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

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.