Sets the suppress state of many timeline entities all at once. Changing them all at once is much more efficient than setting the isSuppressed property of each entity one at a time because the design is recomputed once instead of once per entity.
"design_var" is a variable referencing a Design object. |
"design_var" is a variable referencing a Design object. |
"design_var" is a variable referencing a Design object. |
| Type | Description |
| boolean | Returns true if setting all of the suppress states was successful. This is either all or none. If any of the entities cannot be suppressed, the call fails and none of them are changed. |
| Name | Type | Description |
| entities | Base[] | The entities to suppress or unsuppress. Feature, TimelineObject, and Occurrence objects can be used, and the array can contain a mix of those types. An Occurrence is suppressed through the timeline entry that created it, and a TimelineObject for a group suppresses every entry in that group. The entities must all exist within the Design object you're calling this method from, and the design must be parametric. |
| isSuppressed | boolean | True to suppress the entities and false to unsuppress them. Entities that are already in the requested state are left unchanged. |