SortParams class

Defines a field name and order used to sort query results.

See SortField

Example

var filter = FilterParams.fromTuples(['type', 'Type1']);
var paging =  PagingParams(0, 100);
var sorting =  SortingParams( SortField('create_time', true));

myDataClient.getDataByFilter(filter, paging, sorting, (err, page) {...});
Inheritance

Constructors

SortParams(List<SortField> fields)
Creates a new instance and initializes it with specified sort fields. [...]
SortParams.fromJson(Map<String, dynamic> json)
Creates a new instance from json. [...]
factory

Properties

length ↔ int
Returns the number of objects in this list. [...]
read / write, override
first SortField
Returns the first element. [...]
read / write, inherited
hashCode → int
The hash code for this object. [...]
read-only, inherited
isEmpty → bool
Returns true if there are no elements in this collection. [...]
read-only, inherited
isNotEmpty → bool
Returns true if there is at least one element in this collection. [...]
read-only, inherited
iterator → Iterator<SortField>
Returns a new Iterator that allows iterating the elements of this Iterable. [...]
read-only, inherited
last SortField
Returns the last element. [...]
read / write, inherited
reversed → Iterable<SortField>
Returns an Iterable of the objects in this list in reverse order.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
single SortField
Checks that this iterable has only one element, and returns that element. [...]
read-only, inherited

Methods

fromJson(Map<String, dynamic> json) → void
Returned JSON Map object from values of this object
toJson() → Map<String, dynamic>
Initialize this object from JSON Map object
add(SortField element) → void
Adds value to the end of this list, extending the length by one. [...]
inherited
addAll(Iterable<SortField> iterable) → void
Appends all objects of iterable to the end of this list. [...]
inherited
any(bool test(SortField element)) → bool
Checks whether any element of this iterable satisfies test. [...]
inherited
asMap() → Map<int, SortField>
Returns an unmodifiable Map view of this. [...]
inherited
cast<R>() → List<R>
Returns a view of this list as a list of R instances. [...]
inherited
clear() → void
Removes all objects from this list; the length of the list becomes zero. [...]
inherited
contains(Object element) → bool
Returns true if the collection contains an element equal to element. [...]
inherited
elementAt(int index) SortField
Returns the indexth element. [...]
inherited
every(bool test(SortField element)) → bool
Checks whether every element of this iterable satisfies test. [...]
inherited
expand<T>(Iterable<T> f(SortField element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements. [...]
inherited
fillRange(int start, [ int end, [ SortField fill ]) → void
Sets the objects in the range start inclusive to end exclusive to the given fillValue. [...]
inherited
firstWhere(bool test(SortField element), { SortField orElse() }) SortField
Returns the first element that satisfies the given predicate test. [...]
inherited
fold<T>(T initialValue, T combine(T previousValue, SortField element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value [...]
inherited
followedBy(Iterable<SortField> other) → Iterable<SortField>
Returns the lazy concatentation of this iterable and other. [...]
inherited
forEach(void action(SortField element)) → void
Applies the function f to each element of this collection in iteration order.
inherited
getRange(int start int end) → Iterable<SortField>
Returns an Iterable that iterates over the objects in the range start inclusive to end exclusive. [...]
inherited
indexOf(Object element, [ int start = 0 ]) → int
Returns the first index of element in this list. [...]
inherited
indexWhere(bool test(SortField element), [ int start = 0 ]) → int
Returns the first index in the list that satisfies the provided test. [...]
inherited
insert(int index, SortField element) → void
Inserts the object at position index in this list. [...]
inherited
insertAll(int index, Iterable<SortField> iterable) → void
Inserts all objects of iterable at position index in this list. [...]
inherited
join([String separator = "" ]) → String
Converts each element to a String and concatenates the strings. [...]
inherited
lastIndexOf(Object element, [ int start ]) → int
Returns the last index of element in this list. [...]
inherited
lastIndexWhere(bool test(SortField element), [ int start ]) → int
Returns the last index in the list that satisfies the provided test. [...]
inherited
lastWhere(bool test(SortField element), { SortField orElse() }) SortField
Returns the last element that satisfies the given predicate test. [...]
inherited
map<T>(T f(SortField element)) → Iterable<T>
Returns a new lazy Iterable with elements that are created by calling f on each element of this Iterable in iteration order. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
reduce(SortField combine(SortField previousValue SortField element)) SortField
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function. [...]
inherited
remove(Object element) → bool
Removes the first occurrence of value from this list. [...]
inherited
removeAt(int index) SortField
Removes the object at position index from this list. [...]
inherited
removeLast() SortField
Pops and returns the last object in this list. [...]
inherited
removeRange(int start int end) → void
Removes the objects in the range start inclusive to end exclusive. [...]
inherited
removeWhere(bool test(SortField element)) → void
Removes all objects from this list that satisfy test. [...]
inherited
replaceRange(int start, int end, Iterable<SortField> newContents) → void
Removes the objects in the range start inclusive to end exclusive and inserts the contents of replacement in its place. [...]
inherited
retainWhere(bool test(SortField element)) → void
Removes all objects from this list that fail to satisfy test. [...]
inherited
setAll(int index, Iterable<SortField> iterable) → void
Overwrites objects of this with the objects of iterable, starting at position index in this list. [...]
inherited
setRange(int start, int end, Iterable<SortField> iterable, [ int skipCount = 0 ]) → void
Copies the objects of iterable, skipping skipCount objects first, into the range start, inclusive, to end, exclusive, of the list. [...]
inherited
shuffle([Random random ]) → void
Shuffles the elements of this list randomly.
inherited
singleWhere(bool test(SortField element), { SortField orElse() }) SortField
Returns the single element that satisfies test. [...]
inherited
skip(int count) → Iterable<SortField>
Returns an Iterable that provides all but the first count elements. [...]
inherited
skipWhile(bool test(SortField element)) → Iterable<SortField>
Returns an Iterable that skips leading elements while test is satisfied. [...]
inherited
sort([int compare(SortField a SortField b) ]) → void
Sorts this list according to the order specified by the compare function. [...]
inherited
sublist(int start, [ int end ]) → List<SortField>
Returns a new list containing the elements between start and end. [...]
inherited
take(int count) → Iterable<SortField>
Returns a lazy iterable of the count first elements of this iterable. [...]
inherited
takeWhile(bool test(SortField element)) → Iterable<SortField>
Returns a lazy iterable of the leading elements satisfying test. [...]
inherited
toList({bool growable: true }) → List<SortField>
Creates a List containing the elements of this Iterable. [...]
inherited
toSet() → Set<SortField>
Creates a Set containing the same elements as this iterable. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited
where(bool test(SortField element)) → Iterable<SortField>
Returns a new lazy Iterable with all elements that satisfy the predicate test. [...]
inherited
whereType<T>() → Iterable<T>
Returns a new lazy Iterable with all elements that have type T. [...]
inherited

Operators

operator [](int index) SortField
Returns the object at the given index in the list or throws a RangeError if index is out of bounds.
override
operator []=(int index, SortField item) → void
Sets the value at the given index in the list to value or throws a RangeError if index is out of bounds.
override
operator +(List<SortField> other) → List<SortField>
Returns the concatenation of this list and other. [...]
inherited
operator ==(dynamic other) → bool
The equality operator. [...]
inherited