update_object
Modifies board objects by updating text, position, size, colors, styling, rotation, connectors, or a table cell. Validates all changes before applying, so errors leave the board unchanged.
Instructions
Modifies an object: text, position (top-left corner), size (shapes), colors, line style, font, lock, rotation; a connector's route, arrowheads and ends; one table cell. Everything is validated before anything is applied (an error changes nothing); a parameter that does not suit the object's type is ignored and listed in avertissements. Locked objects can still be modified here.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| h | No | ||
| w | No | ||
| x | No | ||
| y | No | ||
| id | Yes | ||
| to | No | Connector only: id of the object to connect the end to. | |
| cell | No | Table only: [row, column] (from 0) of the cell whose text `text` replaces. | |
| dash | No | ||
| fill | No | Color "#rrggbb" or "ink" (the theme's text color). | |
| from | No | Connector only: id of the object to connect the start to (shape, table or image). | |
| page | No | Page: number (from 1) or name. Defaults to the first. | |
| path | No | Path of the board file (.inkboard; .inkboard.json and .tableau.json also accepted). Optional when the application is open: the tool then acts live on the displayed board (undoable with Ctrl+Z). | |
| text | No | New text of a shape or connector label; with `cell`, the new text of that table cell. | |
| align | No | Text alignment (shapes and connector labels). | |
| arrow | No | Connector only: arrowheads. | |
| route | No | Connector only. | |
| locked | No | Lock or unlock the object in the application. | |
| stroke | No | Color "#rrggbb" or "ink" (the theme's text color). | |
| opacity | No | ||
| markdown | No | Default false (text taken literally). true: `text` is Markdown: **bold**, *italic* (or _italic_), __underline__, ~~strike~~, {color=#e03131}text{/}, {bg=#ffec99}text{/}, {color=#e03131 bg=ink}text{/} (colors: #rrggbb or ink); nesting allowed; \ escapes * _ ~ { } \. Markup that cannot be applied stays literal text and is listed in the `warnings` of the result. | |
| rotation | No | Absolute angle in degrees (shapes and images; 0 resets). | |
| font_size | No | ||
| roundness | No | Corner rounding (0 sharp, 1 capsule). | |
| font_family | No | ||
| stroke_width | No | Outline width (0: no outline). |