vdl-action-update-entity
Update the value of an Array element, Scalar or Parameter. This action will return the new value.
Required parent element
Must be contained within one of the following elements:
Example
<vdl-action-group name="updateArray">
<vdl-action-update-entity entity="MyArray" indices="=[vars.selectedCity, vars.selectedMonth]" value="=5"></vdl-action-update-entity>
</vdl-action-group>
Attributes
entity | Name of the Array to update the element for or name of a Scalar to update the value of. You can only specify one of "set", "entity" or "parameter". | ||
---|---|---|---|
indices | The indices to use to locate the Array element to update. Can be a dynamic expression returning a JavaScript array. Or it can be a comma separated list of indices. | accepts expression | |
parameter | Name of the model Parameter to update the value of. You can only specify one of "set", "entity" or "parameter". | ||
scenario | The scenario to modify the Entity or Parameter from, defaults to the first scenario. You can specify either a scenario id or the current position of the scenario on the shelf. | accepts expression | |
set | Name of the Set entity add an element to. You can only specify one of "set", "entity" or "parameter". | ||
value | The value to update the Entity or Parameter with. This can either be an static value or a dynamic expression. The value will be cast to the data type of the entity. If the value attribute is not set then the current value from the VDL action group will be used. | accepts expression |