Remove an element
remove_elementDelete a diagram element and its attached connections and labels. Disable cascade to keep references for later repair.
Instructions
Delete one element from a scene.
USE THIS for "remove the cache", "delete that arrow", "drop the second database".
Connections pointing at the element, and labels attached to it, are deleted with it by
default - otherwise the scene would keep dangling references. Set cascade to false only
if you plan to repair those references yourself in the same turn.
Removing a 'group' also removes everything inside it. To keep the children, update the
group instead and set frame to false.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cascade | No | Also remove connections and labels attached to it. Default true. | |
| sceneId | Yes | Id of the scene to work on, as returned by render_diagram or create_scene. | |
| elementId | Yes | Id of the element to remove. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present only when success is false. | |
| removed | No | Every id that was deleted, including cascaded ones. | |
| sceneId | No | ||
| success | Yes |