ListNotifier<T> class

A List that behaves like ValueNotifier if its data changes. it does not compare the elements on bulk operations If you set notifyIfEqual to false it will compare if a value passed value passed is equal to the existing value. like list[5]=4 if the content at index 4 is equal to 4 and only call notifyListeners if they are not equal. To allow atomic changes ListNotifier supports a single level of transactions

Inheritance
Implemented types
Mixed-in types
Available extensions

Constructors

ListNotifier({List<T>? data, bool notifyIfEqual = true, bool customEquality(T x, T y)?})
Creates a new listenable List data optional list that should be used as initial value if notifyIfEqual is false ListNotifier will compare if a value passed is equal to the existing value. like list[5]=4 if the content at index 4 is equal to 4 and only call notifyListeners if they are not equal. To prevent users from wondering why their UI doesn't update if they haven't overritten the equality operator the default is true. Alternatively you can pass in a customEquality function that is then used instead of ==

Properties

average → double

Available on Iterable<num>, provided by the IterableNumberExtension extension

The arithmetic mean of the elements of a non-empty iterable.
no setter
average → double

Available on Iterable<int>, provided by the IterableIntegerExtension extension

The arithmetic mean of the elements of a non-empty iterable.
no setter
customEquality → bool Function(T x, T y)?
final
first ↔ T
The first element.
getter/setter pairinherited
firstOrNull → T?

Available on Iterable<T>, provided by the IterableExtension extension

The first element, or null if the iterable is empty.
no setter
firstOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The first element of this iterator, or null if the iterable is empty.
no setter
flattened → Iterable<T>

Available on Iterable<Iterable<T>>, provided by the IterableIterableExtension extension

The sequential elements of each iterable in this iterable.
no setter
flattenedToList → List<T>

Available on Iterable<Iterable<T>>, provided by the IterableIterableExtension extension

The sequential elements of each iterable in this iterable.
no setter
flattenedToSet → Set<T>

Available on Iterable<Iterable<T>>, provided by the IterableIterableExtension extension

The unique sequential elements of each iterable in this iterable.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
indexed → Iterable<(int, T)>

Available on Iterable<T>, provided by the IterableExtensions extension

Pairs of elements of the indices and elements of this iterable.
no setter
isEmpty → bool
Whether this collection has no elements.
no setterinherited
isNotEmpty → bool
Whether this collection has at least one element.
no setterinherited
iterator → Iterator<T>
A new Iterator that allows iterating the elements of this Iterable.
no setterinherited
keys → Iterable<K>

Available on Iterable<RecordSnapshot<K, V>>, provided by the RecordSnapshotIterableExtension extension

Keys
no setter
keysAndValues → Iterable<(K, V)>

Available on Iterable<RecordSnapshot<K, V>>, provided by the RecordSnapshotIterableExtension extension

Key value pairs
no setter
last ↔ T
The last element.
getter/setter pairinherited
lastOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The last element of this iterable, or null if the iterable is empty.
no setter
lastOrNull → T?

Available on Iterable<T>, provided by the IterableExtension extension

The last element, or null if the iterable is empty.
no setter
length ↔ int
The number of elements in this Iterable.
getter/setter pairinherited-getteroverride-setter
max → T

Available on Iterable<T>, provided by the IterableComparableExtension extension

A maximal element of the iterable.
no setter
max → int

Available on Iterable<int>, provided by the IterableIntegerExtension extension

A maximal element of the iterable.
no setter
max → double

Available on Iterable<double>, provided by the IterableDoubleExtension extension

A maximal element of the iterable.
no setter
max → num

Available on Iterable<num>, provided by the IterableNumberExtension extension

A maximal element of the iterable.
no setter
maxOrNull → double?

Available on Iterable<double>, provided by the IterableDoubleExtension extension

A maximal element of the iterable, or null if the iterable is empty.
no setter
maxOrNull → T?

Available on Iterable<T>, provided by the IterableComparableExtension extension

A maximal element of the iterable, or null if the iterable is empty.
no setter
maxOrNull → int?

Available on Iterable<int>, provided by the IterableIntegerExtension extension

A maximal element of the iterable, or null if the iterable is empty.
no setter
maxOrNull → num?

Available on Iterable<num>, provided by the IterableNumberExtension extension

A maximal element of the iterable, or null if the iterable is empty.
no setter
min → double

Available on Iterable<double>, provided by the IterableDoubleExtension extension

A minimal element of the iterable.
no setter
min → int

Available on Iterable<int>, provided by the IterableIntegerExtension extension

A minimal element of the iterable.
no setter
min → T

Available on Iterable<T>, provided by the IterableComparableExtension extension

A minimal element of the iterable.
no setter
min → num

Available on Iterable<num>, provided by the IterableNumberExtension extension

A minimal element of the iterable.
no setter
minOrNull → double?

Available on Iterable<double>, provided by the IterableDoubleExtension extension

A minimal element of the iterable, or null it the iterable is empty.
no setter
minOrNull → int?

Available on Iterable<int>, provided by the IterableIntegerExtension extension

A minimal element of the iterable, or null it the iterable is empty.
no setter
minOrNull → T?

Available on Iterable<T>, provided by the IterableComparableExtension extension

A minimal element of the iterable, or null it the iterable is empty.
no setter
minOrNull → num?

Available on Iterable<num>, provided by the IterableNumberExtension extension

A minimal element of the iterable, or null it the iterable is empty.
no setter
nonNulls → Iterable<T>

Available on Iterable<T?>, provided by the NullableIterableExtensions extension

The non-null elements of this iterable.
no setter
reversed → Iterable<T>
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 → T
Checks that this iterable has only one element, and returns that element.
no setterinherited
singleOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The single element of this iterator, or null.
no setter
singleOrNull → T?

Available on Iterable<T>, provided by the IterableExtension extension

The single element of the iterable, or null.
no setter
sum → int

Available on Iterable<int>, provided by the IterableIntegerExtension extension

The sum of the elements.
no setter
sum → num

Available on Iterable<num>, provided by the IterableNumberExtension extension

The sum of the elements.
no setter
sum → double

Available on Iterable<double>, provided by the IterableDoubleExtension extension

The sum of the elements.
no setter
toJS → JSArray<T>

Available on List<T>, provided by the ListToJSArray extension

Converts this List to a JSArray by either casting, unwrapping, or cloning the List.
no setter
toJSProxyOrRef → JSArray<T>

Available on List<T>, provided by the ListToJSArray extension

Converts this List to a JSArray by either casting, unwrapping, or proxying the List.
no setter
value → List<T>
returns an unmodifiable view on the lists data.
no setteroverride
values → Iterable<V>

Available on Iterable<RecordSnapshot<K, V>>, provided by the RecordSnapshotIterableExtension extension

Values
no setter
wait → Future<List<T>>

Available on Iterable<Future<T>>, provided by the FutureIterable extension

Waits for futures in parallel.
no setter

Methods

add(T value) → void
Adds value to the end of this list, extending the length by one.
override
addAll(Iterable<T> iterable) → void
Appends all objects of iterable to the end of this list.
override
addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
any(bool test(T)) → bool
Checks whether any element of this iterable satisfies test.
inherited
asMap() → Map<int, T>
An unmodifiable Map view of this list.
inherited
asNameMap() → Map<String, T>

Available on Iterable<T>, provided by the EnumByName extension

Creates a map from the names of enum values to the values.
binarySearch(E element, [int compare(E, E)?]) → int

Available on List<E>, provided by the ListComparableExtensions extension

Returns the index of element in this sorted list.
binarySearch(E element, int compare(E, E)) → int

Available on List<E>, provided by the ListExtensions extension

Returns the index of element in this sorted list.
binarySearchBy<K extends Comparable<K>>(E element, K keyOf(E element), [int start = 0, int? end]) → int

Available on List<E>, provided by the ListExtensions extension

Returns the index of element in this sorted list.
binarySearchByCompare<K>(E element, K keyOf(E element), int compare(K, K), [int start = 0, int? end]) → int

Available on List<E>, provided by the ListExtensions extension

Returns the index of element in this sorted list.
byName(String name) → T

Available on Iterable<T>, provided by the EnumByName extension

Finds the enum value in this list with name name.
cast<T>() → List<T>
A view of this iterable as an iterable of R instances.
inherited
clear() → void
Removes all objects from this list; the length of the list becomes zero.
override
contains(Object? element) → bool
Whether the collection contains an element equal to element.
inherited
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
elementAt(int index) → T
Returns the indexth element.
inherited
elementAtOrNull(int index) → T?

Available on Iterable<T>, provided by the IterableExtension extension

The indexth element, or null if there is no such element.
elementAtOrNull(int index) → E?

Available on List<E>, provided by the ListExtensions extension

The indexth element, or null if there is no such element.
elementAtOrNull(int index) → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The element at position index of this iterable, or null.
endTransAction() → void
Ends a transaction
equals(List<E> other, [Equality<E> equality = const DefaultEquality()]) → bool

Available on List<E>, provided by the ListExtensions extension

Whether other has the same elements as this list.
every(bool test(T)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> f(T)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
expandIndexed<R>(Iterable<R> expand(int index, T element)) → Iterable<R>

Available on Iterable<T>, provided by the IterableExtension extension

Expands each element and index to a number of elements in a new iterable.
expandIndexed<R>(Iterable<R> expand(int index, E element)) → Iterable<R>

Available on List<E>, provided by the ListExtensions extension

Expands each element and index to a number of elements in a new iterable.
fillRange(int start, int end, [T? fillValue]) → void
Overwrites a range of elements with fillValue.
override
firstWhere(bool test(T), {T orElse()?}) → T
The first element that satisfies the given predicate test.
inherited
firstWhereIndexedOrNull(bool test(int index, T element)) → T?

Available on Iterable<T>, provided by the IterableExtension extension

The first element whose value and index satisfies test.
firstWhereOrNull(bool test(T element)) → T?

Available on Iterable<T>, provided by the IterableExtension extension

The first element satisfying test, or null if there are none.
fold<T>(T initialValue, T combine(T previousValue, T element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
foldIndexed<R>(R initialValue, R combine(int index, R previous, T element)) → R

Available on Iterable<T>, provided by the IterableExtension extension

Combine the elements with a value and the current index.
followedBy(Iterable<T> other) → Iterable<T>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void f(T)) → void
Invokes action on each element of this iterable in iteration order.
inherited
forEachIndexed(void action(int index, E element)) → void

Available on List<E>, provided by the ListExtensions extension

Takes an action for each element.
forEachIndexed(void action(int index, T element)) → void

Available on Iterable<T>, provided by the IterableExtension extension

Takes an action for each element.
forEachIndexedWhile(bool action(int index, E element)) → void

Available on List<E>, provided by the ListExtensions extension

Takes an action for each element and index as long as desired.
forEachIndexedWhile(bool action(int index, T element)) → void

Available on Iterable<T>, provided by the IterableExtension extension

Takes an action for each element and index as long as desired.
forEachWhile(bool action(T element)) → void

Available on Iterable<T>, provided by the IterableExtension extension

Takes an action for each element as long as desired.
forEachWhile(bool action(E element)) → void

Available on List<E>, provided by the ListExtensions extension

Takes an action for each element as long as desired.
getRange(int start, int end) → Iterable<T>
Creates an Iterable that iterates over a range of elements.
inherited
groupFoldBy<K, G>(K keyOf(T element), G combine(G? previous, T element)) → Map<K, G>

Available on Iterable<T>, provided by the IterableExtension extension

Groups elements by keyOf then folds the elements in each group.
groupListsBy<K>(K keyOf(T element)) → Map<K, List<T>>

Available on Iterable<T>, provided by the IterableExtension extension

Groups elements into lists by keyOf.
groupSetsBy<K>(K keyOf(T element)) → Map<K, Set<T>>

Available on Iterable<T>, provided by the IterableExtension extension

Groups elements into sets by keyOf.
indexOf(T element, [int start = 0]) → int
The first index of element in this list.
inherited
indexWhere(bool test(T), [int start = 0]) → int
The first index in the list that satisfies the provided test.
inherited
insert(int index, T element) → void
Inserts element at position index in this list.
override
insertAll(int index, Iterable<T> iterable) → void
Inserts all objects of iterable at position index in this list.
override
isSorted(Comparator<T> compare) → bool

Available on Iterable<T>, provided by the IterableExtension extension

Whether the elements are sorted by the compare ordering.
isSorted([Comparator<T>? compare]) → bool

Available on Iterable<T>, provided by the IterableComparableExtension extension

Whether the elements are sorted by the compare ordering.
isSortedBy<K extends Comparable<K>>(K keyOf(T element)) → bool

Available on Iterable<T>, provided by the IterableExtension extension

Whether the elements are sorted by their keyOf property.
isSortedByCompare<K>(K keyOf(T element), Comparator<K> compare) → bool

Available on Iterable<T>, provided by the IterableExtension extension

Whether the elements are compare-sorted by their keyOf property.
join([String separator = '']) → String
Converts each element to a String and concatenates the strings.
inherited
lastBy<K>(K key(T)) → Map<K, T>

Available on Iterable<T>, provided by the IterableExtension extension

Associates the elements in this by the value returned by key.
lastIndexOf(T element, [int? start]) → int
The last index of element in this list.
inherited
lastIndexWhere(bool test(T), [int? start]) → int
The last index in the list that satisfies the provided test.
inherited
lastWhere(bool test(T), {T orElse()?}) → T
The last element that satisfies the given predicate test.
inherited
lastWhereIndexedOrNull(bool test(int index, T element)) → T?

Available on Iterable<T>, provided by the IterableExtension extension

The last element whose index and value satisfies test.
lastWhereOrNull(bool test(T element)) → T?

Available on Iterable<T>, provided by the IterableExtension extension

The last element satisfying test, or null if there are none.
lowerBound(E element, int compare(E, E)) → int

Available on List<E>, provided by the ListExtensions extension

Returns the index where element should be in this sorted list.
lowerBound(E element, [int compare(E, E)?]) → int

Available on List<E>, provided by the ListComparableExtensions extension

Returns the index where element should be in this sorted list.
lowerBoundBy<K extends Comparable<K>>(E element, K keyOf(E), [int start = 0, int? end]) → int

Available on List<E>, provided by the ListExtensions extension

Returns the index where element should be in this sorted list.
lowerBoundByCompare<K>(E element, K keyOf(E), int compare(K, K), [int start = 0, int? end]) → int

Available on List<E>, provided by the ListExtensions extension

Returns the index where element should be in this sorted list.
map<T>(T f(T)) → Iterable<T>
The current elements of this iterable modified by toElement.
inherited
mapIndexed<R>(R convert(int index, E element)) → Iterable<R>

Available on List<E>, provided by the ListExtensions extension

Maps each element and its index to a new value.
mapIndexed<R>(R convert(int index, T element)) → Iterable<R>

Available on Iterable<T>, provided by the IterableExtension extension

Maps each element and its index to a new value.
none(bool test(T)) → bool

Available on Iterable<T>, provided by the IterableExtension extension

Whether no element satisfies test.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
If needed you can notifiy all listeners manually
override
reduce(T combine(T value, T element)) → T
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
reduceIndexed(T combine(int index, T previous, T element)) → T

Available on Iterable<T>, provided by the IterableExtension extension

Combine the elements with each other and the current index.
remove(Object? value) → bool
Removes the first occurrence of value from this list.
override
removeAt(int index) → T
Removes the object at position index from this list.
override
removeLast() → T
Removes and returns the last object in this list.
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
removeRange(int start, int end) → void
Removes a range of elements from the list.
override
removeWhere(bool test(T)) → void
Removes all objects from this list that satisfy test.
override
replaceRange(int start, int end, Iterable<T> iterable) → void
Replaces a range of elements with the elements of replacements.
override
retainWhere(bool test(T)) → void
Removes all objects from this list that fail to satisfy test.
override
retype<T>() → List<T>
inherited
reverseRange(int start, int end) → void

Available on List<E>, provided by the ListExtensions extension

Reverses the elements in a range of the list.
sample(int count, [Random? random]) → List<T>

Available on Iterable<T>, provided by the IterableExtension extension

Selects count elements at random from this iterable.
setAll(int index, Iterable<T> iterable) → void
Overwrites elements with the objects of iterable.
override
setRange(int start, int end, Iterable<T> iterable, [int skipCount = 0]) → void
Writes some elements of iterable into a range of this list.
override
shuffle([Random? random]) → void
Shuffles the elements of this list randomly.
override
shuffled([Random? random]) → List<T>

Available on Iterable<T>, provided by the IterableExtension extension

Creates a shuffled list of the elements of the iterable.
shuffleRange(int start, int end, [Random? random]) → void

Available on List<E>, provided by the ListExtensions extension

Shuffle a range of elements.
singleWhere(bool test(T), {T orElse()?}) → T
The single element that satisfies test.
inherited
singleWhereIndexedOrNull(bool test(int index, T element)) → T?

Available on Iterable<T>, provided by the IterableExtension extension

The single element satisfying test.
singleWhereOrNull(bool test(T element)) → T?

Available on Iterable<T>, provided by the IterableExtension extension

The single element satisfying test.
skip(int n) → Iterable<T>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(T)) → Iterable<T>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
slice(int start, [int? end]) → ListSlice<E>

Available on List<E>, provided by the ListExtensions extension

A fixed length view of a range of this list.
slices(int length) → Iterable<List<T>>

Available on Iterable<T>, provided by the IterableExtension extension

Contiguous slices of this with the given length.
slices(int length) → Iterable<List<E>>

Available on List<E>, provided by the ListExtensions extension

Contiguous slices of this with the given length.
sort([int compare(T, T)?]) → void
Sorts this list according to the order specified by the compare function.
override
sortBy<K extends Comparable<K>>(K keyOf(E element), [int start = 0, int? end]) → void

Available on List<E>, provided by the ListExtensions extension

Sorts elements by the natural order of their keyOf property.
sortByCompare<K>(K keyOf(E element), int compare(K a, K b), [int start = 0, int? end]) → void

Available on List<E>, provided by the ListExtensions extension

Sorts elements by the compare of their keyOf property.
sorted(Comparator<T> compare) → List<T>

Available on Iterable<T>, provided by the IterableExtension extension

Creates a sorted list of the elements of the iterable.
sorted([Comparator<T>? compare]) → List<T>

Available on Iterable<T>, provided by the IterableComparableExtension extension

Creates a sorted list of the elements of the iterable.
sortedBy<K extends Comparable<K>>(K keyOf(T element)) → List<T>

Available on Iterable<T>, provided by the IterableExtension extension

Creates a sorted list of the elements of the iterable.
sortedByCompare<K>(K keyOf(T element), Comparator<K> compare) → List<T>

Available on Iterable<T>, provided by the IterableExtension extension

Creates a sorted list of the elements of the iterable.
sortRange(int start, int end, [int compare(E a, E b)?]) → void

Available on List<E>, provided by the ListComparableExtensions extension

Sort a range of elements by compare.
sortRange(int start, int end, int compare(E a, E b)) → void

Available on List<E>, provided by the ListExtensions extension

Sort a range of elements by compare.
splitAfter(bool test(T element)) → Iterable<List<T>>

Available on Iterable<T>, provided by the IterableExtension extension

Splits the elements into chunks after some elements.
splitAfterIndexed(bool test(int index, T element)) → Iterable<List<T>>

Available on Iterable<T>, provided by the IterableExtension extension

Splits the elements into chunks after some elements and indices.
splitBefore(bool test(T element)) → Iterable<List<T>>

Available on Iterable<T>, provided by the IterableExtension extension

Splits the elements into chunks before some elements.
splitBeforeIndexed(bool test(int index, T element)) → Iterable<List<T>>

Available on Iterable<T>, provided by the IterableExtension extension

Splits the elements into chunks before some elements and indices.
splitBetween(bool test(T first, T second)) → Iterable<List<T>>

Available on Iterable<T>, provided by the IterableExtension extension

Splits the elements into chunks between some elements.
splitBetweenIndexed(bool test(int index, T first, T second)) → Iterable<List<T>>

Available on Iterable<T>, provided by the IterableExtension extension

Splits the elements into chunks between some elements and indices.
startTransAction() → void
Starts a transaction that allows to make multiple changes to the List with only one notification at the end.
sublist(int start, [int? end]) → List<T>
Returns a new list containing the elements between start and end.
inherited
swap(int index1, int index2) → void
swaps elements on index1 with index2
swap(int index1, int index2) → void

Available on List<E>, provided by the ListExtensions extension

Swaps two elements of this list.
take(int n) → Iterable<T>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(T)) → Iterable<T>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) → List<T>
Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<T>
Creates a Set containing the same elements as this iterable.
inherited
toString() → String
A string representation of this object.
inherited
where(bool test(T)) → Iterable<T>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereIndexed(bool test(int index, E element)) → Iterable<E>

Available on List<E>, provided by the ListExtensions extension

The elements whose value and index satisfies test.
whereIndexed(bool test(int index, T element)) → Iterable<T>

Available on Iterable<T>, provided by the IterableExtension extension

The elements whose value and index satisfies test.
whereNot(bool test(T element)) → Iterable<T>

Available on Iterable<T>, provided by the IterableExtension extension

The elements that do not satisfy test.
whereNotIndexed(bool test(int index, T element)) → Iterable<T>

Available on Iterable<T>, provided by the IterableExtension extension

The elements whose value and index do not satisfy test.
whereNotIndexed(bool test(int index, E element)) → Iterable<E>

Available on List<E>, provided by the ListExtensions extension

The elements whose value and index do not satisfy test.
whereNotNull() → Iterable<T>

Available on Iterable<T?>, provided by the IterableNullableExtension extension

The non-null elements of this Iterable.
whereType<T>() → Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator +(List<T> other) → List<T>
Returns the concatenation of this list and other.
inherited
operator ==(Object other) → bool
The equality operator.
inherited
operator [](int index) → T
The object at the given index in the list.
override
operator []=(int index, T value) → void
Sets the value at the given index in the list to value.
override