Sets the given fields; a value equal to its default clears the stored field. Changing the shape to rect or ellipse removes a stored radius. Position and transform are set with item.set_transform.
Arguments#
| Argument | Type | Required | Description |
|---|---|---|---|
fill | string | no | A colour. |
height | number | no | Pixels before scale, above 0. |
item_id | string | yes | A shape item. |
radius | number | no | Pixels, 0 or more; rounded_rect only. |
shape | rect, rounded_rect, ellipse | no | |
stroke_color | string | no | A colour. |
stroke_width | number | no | Pixels, 0 or more. |
width | number | no | Pixels before scale, above 0. |
Example#
As one operation of an edit batch (the edit tool of MCP, vukem-video edit --ops, or POST /api/v1/projects/{id}/edit):
{
"op": "shape.set",
"args": {
"item_id": "itm_s6t7v8w9x0",
"radius": 24,
"shape": "rounded_rect",
"width": 600
}
}Errors#
E_VALIDATION, E_NOT_FOUND, E_TYPE_MISMATCH
Scope and phase#
Scope edit, phase alpha. Run vukem-video command:help shape.set for the same description from the binary.