vdl-action-shelf-modify
Modify the current shelf selection by adding, removing or replacing scenarios. If the shelf is modified, the action group chain terminates. If the shelf remains unchanged, the action group continues, passing the original action group value to the next action.
since 5.6Required parent element
Example
<vdl-action-shelf-modify scenario-ids="=[scenarios[0].id, 'scenario_id']" replace-current="true"></vdl-action-shelf-modify>
<vdl-action-shelf-modify scenario-ids="scenario_id_1,scenario_id_2" position="2"></vdl-action-shelf-modify>Attributes
| position | A zero-based index in the current shelf where to insert the scenarios. Negative index counts back from the end of the array, with -1 indicating the second-to-last position. Accepts number or a string that can be cast to a number. If omitted, scenarios are appended to the end of the shelf. Due to potential scenario de-duplication in the resulting shelf, the final position of injected scenarios might differ from the specified index. | since 5.6 | accepts expression | |
|---|---|---|---|---|
| replace-current | Whether to overwrite the existing shelf selection with the new scenarios or modify the current selection. If set to true, the position attribute is ignored. Default value is false. | since 5.6 | accepts expression | |
| scenario-ids | Single scenario ID or array of scenario IDs. If the attribute is not provided, the value passed from the previous action will be used. If set to a falsy value or an empty array and replace-current is true, the current shelf will be cleared. Duplicate scenario IDs will be de-duplicated before injection, retaining only the first occurrence of each ID. | since 5.6 | accepts expression |
© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.