PaperApi

Result of usePaper, the paper instance and imperative actions.

Properties

freeze

readonly freeze: () => void;

Suspend view updates so edits don't repaint until PaperApi.unfreeze. Forwards to paper.freeze(). No-op when the paper isn't resolved yet.

Returns

void

See

paper.freeze()

---

paper

readonly paper: PaperView | null;

Resolved JointJS paper instance, or null until a <Paper> has mounted.

---

unfreeze

readonly unfreeze: () => void;

Resume view updates and flush everything queued while frozen. Forwards to paper.unfreeze(). No-op when the paper isn't resolved yet.

Returns

void

See

paper.unfreeze()

---

wakeUp

readonly wakeUp: () => void;

Trigger a render pass on the paper. Forwards to paper.wakeUp(). No-op when the paper isn't resolved yet.

Returns

void

See

paper.wakeUp()