Constructor
new StateMap(name, stateManager, iterable)
- Description:
Create a reactive Map.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | the property name |
stateManager |
StateManager | the state manager |
iterable |
iterable | an iterable object to create the Map |
Methods
add(value) → {Map}
- Description:
Insert a new element int a list.
Each value needs it's own id attribute. Objects withouts id will be rejected.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
object | the value to add (needs an id attribute) |
Returns:
the resulting Map object
- Type
- Map
checkValue(value)
- Description:
Check if a value is valid to be stored in a a State List.
Only objects with id attribute can be stored in State lists.
This method throws an error if the value is not valid.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
value |
object | (with ID) |
delete(key) → {boolean}
- Description:
Delete an element from the map.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
key |
* |
Returns:
- Type
- boolean
get(key) → {Object}
- Description:
Return a state map element.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
key |
* | the element id |
Returns:
- Type
- Object
has(key) → {boolean}
- Description:
Check whether an element with the specified key exists or not.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
key |
* | the key to find |
Returns:
- Type
- boolean
loadValues(values) → {StateMap}
- Description:
Insert a full list of values using the id attributes as keys.
This method is used mainly to initialize the list. Note each element is indexed by its "id" attribute. This is a basic restriction of StateMap. All elements need an id attribute, otherwise it won't be saved.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
values |
iterable | the values to load |
Returns:
return the this value
- Type
- StateMap
normalizeKey(key) → {string}
- Description:
Return a normalized key value for state map.
Regular maps uses strict key comparissons but state maps are indexed by ID.JSON conversions and webservices sometimes do unexpected types conversions so we convert any integer key to string.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
key |
* | the provided key |
Returns:
- Type
- string
set(key, value) → {Map}
- Description:
Set an element into the map.
Each value needs it's own id attribute. Objects without id will be rejected. The function will throw an error if the value id and the key are not the same.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
key |
* | the key to store |
value |
* | the value to store |
Returns:
the resulting Map object
- Type
- Map
toJSON() → {array}
- Description:
Return a suitable structure for JSON conversion.
This function is needed because new values are compared in JSON. StateMap has Private attributes which cannot be stringified (like this.stateManager which will produce an infinite recursivity).
- Source:
Returns:
- Type
- array