Skip to main content
It shows a sheet with its viewports, and the user can move and add items.

Import

Example

Notes

  • The renderer needs a browser.
  • The renderer shows your document. It does not own it. On an edit event, update your document and call update(document).
  • When the panel changes size, call resize(width, height) in pixels.
  • Sheet coordinates are in millimetres.
  • setNavigation sets how the wheel and the mouse buttons move the view. See the notes on createModelRenderer.
  • Call dispose() when you remove the view.

Signature

Parameters

This function takes no arguments.

Returns

Types

PaperScreenRenderer

An interactive screen view of a PaperDocument (see .spec/debt.md, “Paper / drawing layer”).
NavigationSettings
required
How the wheel and mouse buttons pan and zoom this view.

PaperEditKind

PaperEditEvent

PaperEditKind
required
string
Document id of the affected viewport/annotation; absent on deselect.
{ x: number; y: number; width: number; height: number; }
The target’s current transform (paper mm) after a move/resize.
Annotation
The newly created annotation (present when kind === ‘create’).

PaperToolId

Last modified on October 7, 2026