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
- Available Extensions
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
- first ↔ SortField
-
The first element.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isEmpty → bool
-
Whether this collection has no elements.
no setterinherited
- isNotEmpty → bool
-
Whether this collection has at least one element.
no setterinherited
-
iterator
→ Iterator<
SortField> -
A new
Iterator
that allows iterating the elements of thisIterable
.no setterinherited - last ↔ SortField
-
The last element.
getter/setter pairinherited
- length ↔ int
-
The number of objects in this list.
getter/setter pairoverride
-
reversed
→ Iterable<
SortField> -
An Iterable of the objects in this list in reverse order.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- single → SortField
-
Checks that this iterable has only one element, and returns that element.
no setterinherited
Methods
-
add(
SortField element) → void -
Adds
value
to the end of this list, extending the length by one.override -
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> -
An unmodifiable Map view of this list.
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 -
Whether the collection contains an element equal to
element
.inherited -
elementAt(
int index) → SortField -
Returns the
index
th 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 -
Overwrites a range of elements with
fillValue
.inherited -
firstWhere(
bool test(SortField element), {SortField orElse()?}) → SortField -
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> -
Creates the lazy concatenation of this iterable and
other
.inherited -
forEach(
void action(SortField element)) → void -
Invokes
action
on each element of this iterable in iteration order.inherited -
fromJson(
Map< String, dynamic> json) → void - Returned JSON Map object from values of this object
-
getRange(
int start, int end) → Iterable< SortField> -
Creates an Iterable that iterates over a range of elements.
inherited
-
indexOf(
Object? element, [int start = 0]) → int -
The first index of
element
in this list.inherited -
indexWhere(
bool test(SortField element), [int start = 0]) → int -
The first index in the list that satisfies the provided
test
.inherited -
insert(
int index, SortField element) → void -
Inserts
element
at positionindex
in this list.inherited -
insertAll(
int index, Iterable< SortField> iterable) → void -
Inserts all objects of
iterable
at positionindex
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 -
The last index of
element
in this list.inherited -
lastIndexWhere(
bool test(SortField element), [int? start]) → int -
The last index in the list that satisfies the provided
test
.inherited -
lastWhere(
bool test(SortField element), {SortField orElse()?}) → SortField -
The last element that satisfies the given predicate
test
.inherited -
map<
T> (T f(SortField element)) → Iterable< T> -
The current elements of this iterable modified by
toElement
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent 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 -
Removes and returns the last object in this list.
inherited
-
removeRange(
int start, int end) → void -
Removes a range of elements from the list.
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 -
Replaces a range of elements with the elements of
replacements
.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 elements with the objects of
iterable
.inherited -
setRange(
int start, int end, Iterable< SortField> iterable, [int skipCount = 0]) → void -
Writes some elements of
iterable
into a range of this list.inherited -
shuffle(
[Random? random]) → void -
Shuffles the elements of this list randomly.
inherited
-
singleWhere(
bool test(SortField element), {SortField orElse()?}) → SortField -
The single element that satisfies
test
.inherited -
skip(
int count) → Iterable< SortField> -
Creates an Iterable that provides all but the first
count
elements.inherited -
skipWhile(
bool test(SortField element)) → Iterable< SortField> -
Creates an
Iterable
that skips leading elements whiletest
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
andend
.inherited -
take(
int count) → Iterable< SortField> -
Creates a lazy iterable of the
count
first elements of this iterable.inherited -
takeWhile(
bool test(SortField element)) → Iterable< SortField> -
Creates a lazy iterable of the leading elements satisfying
test
.inherited -
toJson(
) → Map< String, dynamic> - Initialize this object from JSON Map object
-
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 -
A string representation of this object.
inherited
-
where(
bool test(SortField element)) → Iterable< SortField> -
Creates a new lazy Iterable with all elements that satisfy the
predicate
test
.inherited -
whereType<
T> () → Iterable< T> -
Creates a new lazy Iterable with all elements that have type
T
.inherited
Operators
-
operator +(
List< SortField> other) → List<SortField> -
Returns the concatenation of this list and
other
.inherited -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
int index) → SortField -
The object at the given
index
in the list.override -
operator []=(
int index, SortField item) → void -
Sets the value at the given
index
in the list tovalue
.override