Description

Orders array by the expression predicate.

Note: this function is used to augment the Array type in angular expressions. See angular.Array for more info.

Dependencies

Usage

angular.Array.orderBy(array, expression[, reverse]);

Parameters

array – {Array} –
The array to sort.
expression – {function(*, *)|string|Array.<(function(*, *)|string)>} –
A predicate to be used by the comparator to determine the order of elements.

Can be one of:
- function: JavaScript's Array#sort comparator function
- string: angular expression which evaluates to an object to order by, such as 'name' to sort by a property called 'name'. Optionally prefixed with + or - to control ascending or descending sort order (e.g. +name or -name).
- Array: array of function or string predicates, such that a first predicate in the array is used for sorting, but when the items are equivalent next predicate is used.
reverse(optional) – {boolean} –
Reverse the order the array.

Returns

{Array} –

Sorted copy of the source array.

Example

<div ng:init="friends = [{name:'John', phone:'555-1212', age:10}, {name:'Mary', phone:'555-9876', age:19}, {name:'Mike', phone:'555-4321', age:21}, {name:'Adam', phone:'555-5678', age:35}, {name:'Julie', phone:'555-8765', age:29}]"></div> <pre>Sorting predicate = {{predicate}}</pre> <hr/> <table ng:init="predicate='-age'"> <tr> <th><a href="" ng:click="predicate = 'name'">Name</a> (<a href ng:click="predicate = '-name'">^</a>)</th> <th><a href="" ng:click="predicate = 'phone'">Phone</a> (<a href ng:click="predicate = '-phone'">^</a>)</th> <th><a href="" ng:click="predicate = 'age'">Age</a> (<a href ng:click="predicate = '-age'">^</a>)</th> <tr> <tr ng:repeat="friend in friends.$orderBy(predicate)"> <td>{{friend.name}}</td> <td>{{friend.phone}}</td> <td>{{friend.age}}</td> <tr> </table>