- filter in module ng
Orders a specified array
by the expression
predicate. It is ordered alphabetically for strings and numerically for numbers. Note: if you notice numbers are not being sorted as expected, make sure they are actually being saved as numbers and not strings. Array-like values (e.g. NodeLists, jQuery objects, TypedArrays, Strings, etc) are also supported.
Usage
In HTML Template Binding
{{ orderBy_expression | orderBy : expression : reverse}}
In JavaScript
$filter('orderBy')(array, expression, reverse)
Arguments
Param | Type | Details |
---|---|---|
array | Array | The array (or array-like object) 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:
|
reverse (optional) | boolean | Reverse the order of the array. |
Returns
Array |
Sorted copy of the source array. |
The example below demonstrates a simple ngRepeat, where the data is sorted by age in descending order (predicate is set to '-age'
). reverse
is not set, which means it defaults to false
.
The predicate and reverse parameters can be controlled dynamically through scope properties, as shown in the next example.
It's also possible to call the orderBy filter manually, by injecting $filter
, retrieving the filter routine with $filter('orderBy')
, and calling the returned filter routine with the desired parameters.
Example:
Please login to continue.