vdl-action-remove-entity
Remove one or more elements from an Array or Set entity corresponding to the indices specified. Can also be used to clear the value from a parameter or Scalar entity. The value passed into this action will return unchanged.
Required parent element
Must be contained within one of the following elements:
Example
<vdl-action-group name="removeElementFromArray">
<vdl-action-remove-entity entity="MyArray" indices="=[['New York', 'January'], ['New York', 'February']]"></vdl-action-remove-entity>
</vdl-action-group>Attributes
| entity | Name of the Array to remove the elements from or name of a Scalar to clear the value of. You can only specify one of "set", "entity" or "parameter". | ||
|---|---|---|---|
| indices | The indices to use to locate the Array or Set element(s) to remove. Can be a dynamic expression returning a JavaScript array or array of arrays. Or it can be a comma separated list of indices. | accepts expression | |
| parameter | Name of the model Parameter to clear the value of. You can only specify one of "set", "entity" or "parameter". | ||
| scenario | The scenario to modify the Entity, Set 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 to remove the elements from. You can only specify one of "set", "entity" or "parameter". |