import {SortableStoreBehavior} from './src/behaviors/sortable-store.js'

public class | source

SortableStoreBehavior

src/behaviors/behavior~Behavior → SortableStoreBehavior

Constructor Summary

Public Constructor
public	constructor(instance: , objectPattern1: {"collection": })

Public Methods
public	onSortChange(expression: String/Array/Boolean) This is a handler proxy for the Store.
public	onSortClear()

This is a handler proxy for the Store. It get's called with the payload of the ENTITY_SORT_CHANGE action.

Name Type Attribute Description

expression

Name	Type	Attribute	Description
expression	String/Array/Boolean		This can be any valid angular orderBy $filter expression, or a reverse boolean if the collection we are sorting contains primitives. Valid angular orderBy $filter expressions are `function`: Getter function. The result of this function will be sorted using the `<`, `===`, `>` operator. `string`: An Angular expression. The result of this expression is used to compare elements (for example `name` to sort by a property called `name` or `name.substr(0, 3)` to sort by 3 first characters of a property called `name`). The result of a constant expression is interpreted as a property name to be used in comparisons (for example `"special name"` to sort object by the value of their `special name` property). An expression can be optionally prefixed with `+` or `-` to control ascending or descending sort order (for example, `+name` or `-name`). If no property is provided, (e.g. `'+'`) then the array element itself is used to compare where sorting. `Array`: An array of string predicates. The first predicate in the array is used for sorting, but when two items are equivalent, the next predicate is used.

String/Array/Boolean

This can be any valid angular orderBy $filter expression, or a reverse boolean if the collection we are sorting contains primitives.

Valid angular orderBy $filter expressions are

function: Getter function. The result of this function will be sorted using the <, ===, > operator.
string: An Angular expression. The result of this expression is used to compare elements (for example name to sort by a property called name or name.substr(0, 3) to sort by 3 first characters of a property called name). The result of a constant expression is interpreted as a property name to be used in comparisons (for example "special name" to sort object by the value of their special name property). An expression can be optionally prefixed with + or - to control ascending or descending sort order (for example, +name or -name). If no property is provided, (e.g. '+') then the array element itself is used to compare where sorting.
Array: An array of string predicates. The first predicate in the array is used for sorting, but when two items are equivalent, the next predicate is used.