Constructor
new SortDescriptor(key, descendingopt)
Constructor.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
key | string | the property to sort on | |
descending | boolean | <optional> |
|
- Source
Members
descending
Get the sorting direction.
- Source
key
Get the sort property name.
- Source
Methods
toUriEncoding(indexopt, propertyNameopt) → {string}
Get this object as a standard URI encoded (query parameters) string value.
If index
is provided and non-negative, then the query parameters will be encoded as an array property named sorts
. Otherwise just bare key
and descending
properties will be used. The descending
property is only added if it is true
.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
index | number | <optional> | an optional array property index | |
propertyName | string | <optional> | sorts | an optional array property name, only used if |
- Source
Returns:
the URI encoded string
- Type:
- string