render
Returns a PNG image of the Inkboard whiteboard to visually check your work without changing the board. Optionally frames a region or object IDs and can label visible IDs for editing.
Instructions
Returns a PNG picture of the board (or of a part of it) as an image, to check your work visually. Read-only: the board, the file and the undo history are untouched. By default the whole page content is shown. region {x, y, w, h} (board units) shows exactly that rectangle; ids frames the given objects (plus padding) while still drawing their surroundings; give either, not both. show_ids: true draws a small white badge with the id of every visible object (top-left corner; middle of an arrow) so you can link what you see to the ids that update_object or add_connector expect (pen strokes get none). The longest side is max_px pixels (default 1400, 16 to 3000; a small region is enlarged 4 times at most); a PNG above 4 MiB is automatically produced smaller (said in note). output also writes the PNG to a .png file under the allowed root, for clients that do not display images. Text is measured approximately, as in export.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Ids of the objects to frame (not combinable with `region`). | |
| 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). | |
| max_px | No | Longest side of the image in pixels. Default 1400. | |
| output | No | Also write the PNG to this file (must end with .png, under the allowed root). | |
| region | No | Rectangle of the board to show, in board units (as the x/y/w/h of describe_board). Padding is not added. | |
| padding | No | Margin around the content or the framed ids, in board units. Default 24. | |
| show_ids | No | Draw the object ids on the picture. Default false. |