Group objects
group_objectsWrap multiple existing objects into a new group to organize them together. Use when you need to collect several objects under one parent group.
Instructions
Wrap existing objects (object_ids, ≥ 1, all must exist) in a NEW <g>.
When to use: collecting several existing objects under one group. For an EMPTY group use
create_group; to move a single object into an existing group use reparent_object.
Key params: object_ids ≥ 1, all must exist; object_id to pin the new group id. The objects
keep their own transforms / styles; only their parent changes.
Return shape: CreateResult — object_id is the new group id (inserted at the position of the
first target), bbox=None, plus the pipeline fields.
Example: group_objects(doc_id, ["icon", "label"])
Render and look before you trust this edit: render with render_preview (or live_render_view)
and inspect the result before relying on it; restore_snapshot reverts it if it is wrong.
Risk class: medium (reversible write-new on the working copy; original untouched).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doc_id | Yes | ||
| object_id | No | ||
| object_ids | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bbox | No | ||
| doc_id | Yes | ||
| changed | Yes | ||
| summary | No | ||
| object_id | Yes | ||
| snapshot_id | Yes | ||
| operation_id | Yes | ||
| preview_after | No | ||
| preview_before | No |