@joint/react
    Preparing search index...

    Interface PaperApi

    Result of usePaper, the paper instance and imperative actions.

    interface PaperApi {
        freeze: () => void;
        paper: PaperView | null;
        unfreeze: () => void;
        wakeUp: () => void;
    }
    Index

    Properties

    freeze paper unfreeze wakeUp

    Properties

    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.

    https://docs.jointjs.com/api/dia/Paper#freeze

    paper: PaperView | null

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

    unfreeze: () => void

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

    https://docs.jointjs.com/api/dia/Paper#unfreeze

    wakeUp: () => void

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

    https://docs.jointjs.com/api/dia/Paper#wakeUp

    Settings

    Member Visibility

    On This Page

    Properties