ObservableMap<K, V> class Null safety

The ObservableMap tracks the various read-methods (eg: Map.length, Map.isEmpty) and write-methods (eg: Map.[]=, Map.clear) making it easier to use it inside reactions.

As the name suggests, this is the Observable-counterpart to the standard Dart Map<K,V>.

final map = ObservableMap<String, int>.of({'first': 1});

autorun((_) {
  print(map['first']);
}) // prints 1

map['first'] = 100; // autorun prints 100
Implemented types
Mixed in types
Available Extensions

Constructors

ObservableMap({ReactiveContext? context, String? name})
ObservableMap.linkedHashMapFrom(Map<K, V> other, {ReactiveContext? context, String? name})
ObservableMap.of(Map<K, V> other, {ReactiveContext? context, String? name})
ObservableMap.splayTreeMapFrom(Map<K, V> other, {int compare(K, K)?, bool isValidKey(dynamic)?, ReactiveContext? context, String? name})

Properties

entries Iterable<MapEntry<K, V>>
The map entries of this.
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
isEmpty bool
Whether there is no key/value pair in the map.
read-only, override
isNotEmpty bool
Whether there is at least one key/value pair in the map.
read-only, override
keys Iterable<K>
The keys of this. [...]
read-only, override
length int
The number of key/value pairs in the map.
read-only, override
name String
read-only
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
values Iterable<V>
The values of this. [...]
read-only, inherited

Methods

addAll(Map<K, V> other) → void
Adds all key/value pairs of other to this map. [...]
inherited
addEntries(Iterable<MapEntry<K, V>> newEntries) → void
Adds all key/value pairs of newEntries to this map. [...]
inherited
cast<RK, RV>() Map<RK, RV>
Provides a view of this map as having RK keys and RV instances, if necessary. [...]
override
clear() → void
Removes all entries from the map. [...]
override
containsKey(Object? key) bool
Whether this map contains the given key. [...]
override
containsValue(Object? value) bool
Whether this map contains the given value. [...]
inherited
forEach(void action(K key, V value)) → void
Applies action to each key/value pair of the map. [...]
inherited
map<K2, V2>(MapEntry<K2, V2> transform(K key, V value)) Map<K2, V2>
Returns a new map where all entries of this map are transformed by the given convert function.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
observe(MapChangeListener<K, V> listener, {bool fireImmediately = false}) Dispose
Used to attach a listener for getting notified on changes happening to the map [...]
override
putIfAbsent(K key, V ifAbsent()) → V
Look up the value of key, or add a new entry if it isn't there. [...]
inherited
remove(Object? key) → V?
Removes key and its associated value, if present, from the map. [...]
override
removeWhere(bool test(K key, V value)) → void
Removes all entries of this map that satisfy the given test.
inherited
toString() String
A string representation of this object. [...]
inherited
update(K key, V update(V value), {V ifAbsent()?}) → V
Updates the value for the provided key. [...]
inherited
updateAll(V update(K key, V value)) → void
Updates all values. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited
operator [](Object? key) → V?
The value for the given key, or null if key is not in the map. [...]
override
operator []=(K key, V value) → void
Associates the key with the given value. [...]
override