ListSignal<E> class
A Signal that holds a List.
- Inheritance
-
- Implemented types
-
- Available extensions
Properties
-
autoDispose
↔ bool
-
Throws and error if read after dispose and can be
disposed on last unsubscribe.
getter/setter pairinherited
-
brand
→ Symbol
-
finalinherited
-
debugLabel
→ String?
-
Debug label for Debug Mode
finalinherited
-
disposed
↔ bool
-
Check if the effect is disposed
getter/setter pairinherited
-
equalityCheck
↔ bool Function(List<E> a, List<E> b)
-
Optional method to check if to values are the same
getter/setter pairinherited
-
first
↔ E
-
The first element.
getter/setter pairinherited-getteroverride-setter
-
globalId
→ int
-
Global ID of the signal
finalinherited
-
hashCode
→ int
-
The hash code for this object.
no setteroverride
-
initialValue
↔ List<E>
-
Value that the signal was created with
getter/setter pairinherited
-
internalValue
↔ List<E>
-
getter/setter pairinherited
-
isEmpty
→ bool
-
Whether this collection has no elements.
no setterinherited
-
isInitialized
↔ bool
-
Check if the value is set and not a lazy signal
getter/setter pairinherited
-
isNotEmpty
→ bool
-
Whether this collection has at least one element.
no setterinherited
-
iterator
→ Iterator<E>
-
A new
Iterator that allows iterating the elements of this Iterable.
no setterinherited
-
last
↔ E
-
The last element.
getter/setter pairoverride-setter
-
length
↔ int
-
The number of elements in this Iterable.
getter/setter pairinherited-getteroverride-setter
-
node
↔ Node?
-
getter/setter pairinherited
-
previousValue
→ List<E>
-
Previous value that was set before the current
no setterinherited
-
reversed
→ Iterable<E>
-
An Iterable of the objects in this list in reverse order.
no setteroverride
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
single
→ E
-
Checks that this iterable has only one element, and returns that element.
no setterinherited
-
targets
↔ Node?
-
getter/setter pairinherited
-
value
↔ List<E>
-
Compute the current value
getter/setter pairinherited
-
version
↔ int
-
Version numbers should always be >= 0, because the special value -1 is used
by Nodes to signify potentially unused but recyclable nodes.
getter/setter pairinherited
Methods
-
add(E value)
→ void
-
Adds
value to the end of this list,
extending the length by one.
override
-
addAll(Iterable<E> iterable)
→ void
-
Appends all objects of
iterable to the end of this list.
override
-
any(bool test(E element))
→ bool
-
Checks whether any element of this iterable satisfies
test.
inherited
-
asMap()
→ Map<int, E>
-
An unmodifiable Map view of this list.
override
-
call()
→ List<E>
-
Return the value when invoked
inherited
-
cast<R>()
→ List<R>
-
A view of this iterable as an iterable of
R instances.
-
clear()
→ void
-
Removes all objects from this list; the length of the list becomes zero.
override
-
contains(Object? value)
→ bool
-
Whether the collection contains an element equal to
element.
inherited
-
dispose()
→ void
-
Dispose the signal
inherited
-
elementAt(int index)
→ E
-
Returns the
indexth element.
inherited
-
every(bool test(E element))
→ bool
-
Checks whether every element of this iterable satisfies
test.
inherited
-
expand<T>(Iterable<T> toElements(E element))
→ Iterable<T>
-
Expands each element of this Iterable into zero or more elements.
-
fillRange(int start, int end, [E? fillValue])
→ void
-
Overwrites a range of elements with
fillValue.
override
-
firstWhere(bool test(E element), {E orElse()?})
→ E
-
The first element that satisfies the given predicate
test.
-
fold<T>(T initialValue, T combine(T previousValue, E element))
→ T
-
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
-
followedBy(Iterable<E> other)
→ Iterable<E>
-
Creates the lazy concatenation of this iterable and
other.
-
forEach(void action(E element))
→ void
-
Invokes
action on each element of this iterable in iteration order.
inherited
-
get()
→ List<E>
-
Helper method to get the current value
inherited
-
getRange(int start, int end)
→ Iterable<E>
-
Creates an Iterable that iterates over a range of elements.
override
-
indexOf(E element, [int start = 0])
→ int
-
The first index of
element in this list.
override
-
indexWhere(bool test(E element), [int start = 0])
→ int
-
The first index in the list that satisfies the provided
test.
override
-
insert(int index, E element)
→ void
-
Inserts
element at position index in this list.
override
-
insertAll(int index, Iterable<E> iterable)
→ void
-
Inserts all objects of
iterable at position index in this list.
override
-
internalRefresh()
→ bool
-
inherited
-
internalSetValue(List<E> val)
→ void
-
inherited
-
join([String separator = ""])
→ String
-
Converts each element to a String and concatenates the strings.
inherited
-
lastIndexOf(E element, [int? start])
→ int
-
The last index of
element in this list.
override
-
lastIndexWhere(bool test(E element), [int? start])
→ int
-
The last index in the list that satisfies the provided
test.
override
-
lastWhere(bool test(E element), {E orElse()?})
→ E
-
The last element that satisfies the given predicate
test.
inherited
-
map<T>(T toElement(E e))
→ 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
-
onDispose(void cleanup())
→ EffectCleanup
-
Add a cleanup function to be called when the signal is disposed
inherited
-
overrideWith(List<E> val)
→ Signal<List<E>>
-
Override the current signal with a new value as if it was created with it
inherited
-
peek()
→ List<E>
-
In the rare instance that you have an effect that should write to another signal based on the previous value, but you don't want the effect to be subscribed to that signal, you can read a signals's previous value via
signal.peek().
inherited
-
readonly()
→ ReadonlySignal<List<E>>
-
Returns a readonly signal
inherited
-
reduce(E combine(E value, E element))
→ E
-
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
remove(Object? value)
→ bool
-
Removes the first occurrence of
value from this list.
override
-
removeAt(int index)
→ E
-
Removes the object at position
index from this list.
override
-
removeLast()
→ E
-
Removes and returns the last object in this list.
override
-
removeRange(int start, int end)
→ void
-
Removes a range of elements from the list.
override
-
removeWhere(bool test(E element))
→ void
-
Removes all objects from this list that satisfy
test.
override
-
replaceRange(int start, int end, Iterable<E> replacements)
→ void
-
Replaces a range of elements with the elements of
replacements.
override
-
retainWhere(bool test(E element))
→ void
-
Removes all objects from this list that fail to satisfy
test.
override
-
set(List<E> val, {bool force = false})
→ bool
-
Set the current value by a method
inherited
-
setAll(int index, Iterable<E> iterable)
→ void
-
Overwrites elements with the objects of
iterable.
override
-
setRange(int start, int end, Iterable<E> 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
-
singleWhere(bool test(E element), {E orElse()?})
→ E
-
The single element that satisfies
test.
inherited
-
skip(int count)
→ Iterable<E>
-
Creates an Iterable that provides all but the first
count elements.
inherited
-
skipWhile(bool test(E value))
→ Iterable<E>
-
Creates an
Iterable that skips leading elements while test is satisfied.
inherited
-
sort([int compare(E a, E b)?])
→ void
-
Sorts this list according to the order specified by the
compare function.
override
-
sorted([int compare(E a, E b)?])
→ List<E>
-
Return a new array that is sorted by the
compare function
-
sublist(int start, [int? end])
→ List<E>
-
Returns a new list containing the elements between
start and end.
override
-
subscribe(void fn(List<E> value))
→ void Function()
-
Subscribe to value changes with a dispose function
inherited
-
subscribeToNode(Node node)
→ void
-
inherited
-
take(int count)
→ Iterable<E>
-
Creates a lazy iterable of the
count first elements of this iterable.
inherited
-
takeWhile(bool test(E value))
→ Iterable<E>
-
Creates a lazy iterable of the leading elements satisfying
test.
inherited
-
toJson()
→ dynamic
-
Convert value to JSON
inherited
-
toList({bool growable = true})
→ List<E>
-
Creates a List containing the elements of this Iterable.
inherited
-
toSet()
→ Set<E>
-
Creates a Set containing the same elements as this iterable.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
unsubscribeFromNode(Node node)
→ void
-
inherited
-
where(bool test(E element))
→ Iterable<E>
-
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
