Skip to Content
MosaicMosaicDocs
Tool Reference

RenderCanvas

See a read-only PNG photo of a Mosaic canvas using the actual Canvas shape/text renderer.

Starter documentation. Features and account details may differ from this deployment.

RenderCanvas

See a read-only PNG photo of a Mosaic canvas using the actual Canvas shape/text renderer. Returns a native image plus an immutable revision, source clock, world crop bounds and object IDs. Use for visual/layout understanding and to review edits. Optional item_ids fit a selection; crop requests precise world bounds. No UI, cursors or ghosts are included. Referenced media not accessible to this scoped renderer is explicitly marked unavailable; this tool never fetches arbitrary URLs or expands reference permissions. Image pixels map linearly across crop bounds; use ReadCanvas for exact geometry.

Parameters

ParameterTypeRequiredDescription
document_idstringYesCanvas document ID from the attachment or search.
item_idsstring[]NoOptional stable item selection used to fit the crop, at most 100.
cropCanvasBoundsNoOptional world-space rectangle; overrides selection-derived bounds.

On this page