js-draw 1.3.0 → 1.4.0

package/dist/cjs/tools/SelectionTool/Selection.js

@@ -40,13 +40,16 @@ const Erase_1 = __importDefault(require("../../commands/Erase"));
 const Duplicate_1 = __importDefault(require("../../commands/Duplicate"));
 const TransformMode_1 = require("./TransformMode");
 const types_1 = require("./types");
-const EditorImage_1 = __importDefault(require("../../EditorImage"));
+const EditorImage_1 = __importDefault(require("../../image/EditorImage"));
 const updateChunkSize = 100;
 const maxPreviewElemCount = 500;
 // @internal
 class Selection {
     constructor(startPoint, editor) {
         this.editor = editor;
+        // The last-computed bounding box of selected content
+        // @see getTightBoundingBox
+        this.selectionTightBoundingBox = null;
         this.transform = math_1.Mat33.identity;
         this.selectedElems = [];
         this.hasParent = true;
@@ -65,10 +68,23 @@ class Selection {
         this.backgroundElem = document.createElement('div');
         this.backgroundElem.classList.add(`${SelectionTool_1.cssPrefix}selection-background`);
         this.container.appendChild(this.backgroundElem);
-        const resizeHorizontalHandle = new SelectionHandle_1.default(SelectionHandle_1.HandleShape.Square, math_1.Vec2.of(1, 0.5), this, this.editor.viewport, (startPoint) => this.transformers.resize.onDragStart(startPoint, types_1.ResizeMode.HorizontalOnly), (currentPoint) => this.transformers.resize.onDragUpdate(currentPoint), () => this.transformers.resize.onDragEnd());
-        const resizeVerticalHandle = new SelectionHandle_1.default(SelectionHandle_1.HandleShape.Square, math_1.Vec2.of(0.5, 1), this, this.editor.viewport, (startPoint) => this.transformers.resize.onDragStart(startPoint, types_1.ResizeMode.VerticalOnly), (currentPoint) => this.transformers.resize.onDragUpdate(currentPoint), () => this.transformers.resize.onDragEnd());
-        const resizeBothHandle = new SelectionHandle_1.default(SelectionHandle_1.HandleShape.Square, math_1.Vec2.of(1, 1), this, this.editor.viewport, (startPoint) => this.transformers.resize.onDragStart(startPoint, types_1.ResizeMode.Both), (currentPoint) => this.transformers.resize.onDragUpdate(currentPoint), () => this.transformers.resize.onDragEnd());
-        const rotationHandle = new SelectionHandle_1.default(SelectionHandle_1.HandleShape.Circle, math_1.Vec2.of(0.5, 0), this, this.editor.viewport, (startPoint) => this.transformers.rotate.onDragStart(startPoint), (currentPoint) => this.transformers.rotate.onDragUpdate(currentPoint), () => this.transformers.rotate.onDragEnd());
+        const resizeHorizontalHandle = new SelectionHandle_1.default({
+            action: SelectionHandle_1.HandleAction.ResizeX,
+            side: math_1.Vec2.of(1, 0.5),
+        }, this, this.editor.viewport, (startPoint) => this.transformers.resize.onDragStart(startPoint, types_1.ResizeMode.HorizontalOnly), (currentPoint) => this.transformers.resize.onDragUpdate(currentPoint), () => this.transformers.resize.onDragEnd());
+        const resizeVerticalHandle = new SelectionHandle_1.default({
+            action: SelectionHandle_1.HandleAction.ResizeY,
+            side: math_1.Vec2.of(0.5, 1),
+        }, this, this.editor.viewport, (startPoint) => this.transformers.resize.onDragStart(startPoint, types_1.ResizeMode.VerticalOnly), (currentPoint) => this.transformers.resize.onDragUpdate(currentPoint), () => this.transformers.resize.onDragEnd());
+        const resizeBothHandle = new SelectionHandle_1.default({
+            action: SelectionHandle_1.HandleAction.ResizeXY,
+            side: math_1.Vec2.of(1, 1),
+        }, this, this.editor.viewport, (startPoint) => this.transformers.resize.onDragStart(startPoint, types_1.ResizeMode.Both), (currentPoint) => this.transformers.resize.onDragUpdate(currentPoint), () => this.transformers.resize.onDragEnd());
+        const rotationHandle = new SelectionHandle_1.default({
+            action: SelectionHandle_1.HandleAction.Rotate,
+            side: math_1.Vec2.of(0.5, 0),
+            icon: this.editor.icons.makeRotateIcon(),
+        }, this, this.editor.viewport, (startPoint) => this.transformers.rotate.onDragStart(startPoint), (currentPoint) => this.transformers.rotate.onDragUpdate(currentPoint), () => this.transformers.rotate.onDragEnd());
         this.handles = [
             resizeBothHandle,
             resizeHorizontalHandle,
@@ -195,18 +211,26 @@ class Selection {
     // Returns false if the selection is empty.
     recomputeRegion() {
         const newRegion = this.computeTightBoundingBox();
+        this.selectionTightBoundingBox = newRegion;
         if (!newRegion) {
             this.cancelSelection();
             return false;
         }
         this.originalRegion = newRegion;
+        this.padRegion();
+        return true;
+    }
+    // Applies padding to the current region if it is too small.
+    // @internal
+    padRegion() {
+        const sourceRegion = this.selectionTightBoundingBox ?? this.originalRegion;
         const minSize = this.getMinCanvasSize();
-        if (this.originalRegion.w < minSize || this.originalRegion.h < minSize) {
+        if (sourceRegion.w < minSize || sourceRegion.h < minSize) {
             // Add padding
             const padding = minSize / 2;
-            this.originalRegion = math_1.Rect2.bboxOf(this.originalRegion.corners, padding);
+            this.originalRegion = math_1.Rect2.bboxOf(sourceRegion.corners, padding);
+            this.updateUI();
         }
-        return true;
     }
     getMinCanvasSize() {
         const canvasHandleSize = SelectionHandle_1.handleSize / this.editor.viewport.getScaleFactor();
@@ -230,6 +254,14 @@ class Selection {
         const rotationDeg = this.screenRegionRotation * 180 / Math.PI;
         this.backgroundElem.style.transform = `rotate(${rotationDeg}deg)`;
         this.backgroundElem.style.transformOrigin = 'center';
+        // If closer to perpendicular, apply different CSS
+        const perpendicularClassName = `${SelectionTool_1.cssPrefix}rotated-near-perpendicular`;
+        if (Math.abs(Math.sin(this.screenRegionRotation)) > 0.5) {
+            this.container.classList.add(perpendicularClassName);
+        }
+        else {
+            this.container.classList.remove(perpendicularClassName);
+        }
         for (const handle of this.handles) {
             handle.updatePosition();
         }
@@ -401,6 +433,7 @@ class Selection {
     }
     setToPoint(point) {
         this.originalRegion = this.originalRegion.grownToPoint(point);
+        this.selectionTightBoundingBox = null;
         this.updateUI();
     }
     cancelSelection() {
@@ -408,12 +441,15 @@ class Selection {
             this.container.remove();
         }
         this.originalRegion = math_1.Rect2.empty;
+        this.selectionTightBoundingBox = null;
         this.hasParent = false;
     }
     setSelectedObjects(objects, bbox) {
         this.addRemoveSelectionFromImage(true);
         this.originalRegion = bbox;
+        this.selectionTightBoundingBox = bbox;
         this.selectedElems = objects.filter(object => object.isSelectable());
+        this.padRegion();
         this.updateUI();
     }
     getSelectedObjects() {

package/dist/cjs/tools/SelectionTool/SelectionHandle.d.ts

@@ -2,17 +2,23 @@ import { Point2, Vec2 } from '@js-draw/math';
 import Selection from './Selection';
 import Pointer from '../../Pointer';
 import Viewport from '../../Viewport';
-export declare enum HandleShape {
-    Circle = 0,
-    Square = 1
+export declare enum HandleAction {
+    ResizeXY = "resize-xy",
+    Rotate = "rotate",
+    ResizeX = "resize-x",
+    ResizeY = "resize-y"
+}
+export interface HandlePresentation {
+    side: Vec2;
+    icon?: Element;
+    action: HandleAction;
 }
 export declare const handleSize = 30;
 export type DragStartCallback = (startPoint: Point2) => void;
 export type DragUpdateCallback = (canvasPoint: Point2) => void;
 export type DragEndCallback = () => void;
 export default class SelectionHandle {
-    readonly shape: HandleShape;
-    private readonly parentSide;
+    readonly presentation: HandlePresentation;
     private readonly parent;
     private readonly viewport;
     private readonly onDragStart;
@@ -20,7 +26,9 @@ export default class SelectionHandle {
     private readonly onDragEnd;
     private element;
     private snapToGrid;
-    constructor(shape: HandleShape, parentSide: Vec2, parent: Selection, viewport: Viewport, onDragStart: DragStartCallback, onDragUpdate: DragUpdateCallback, onDragEnd: DragEndCallback);
+    private shape;
+    private parentSide;
+    constructor(presentation: HandlePresentation, parent: Selection, viewport: Viewport, onDragStart: DragStartCallback, onDragUpdate: DragUpdateCallback, onDragEnd: DragEndCallback);
     /**
      * Adds this to `container`, where `conatiner` should be the background/selection
      * element visible on the screen.

package/dist/cjs/tools/SelectionTool/SelectionHandle.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleSize = exports.HandleShape = void 0;
+exports.handleSize = exports.HandleAction = void 0;
 const assertions_1 = require("../../util/assertions");
 const math_1 = require("@js-draw/math");
 const SelectionTool_1 = require("./SelectionTool");
@@ -8,12 +8,18 @@ var HandleShape;
 (function (HandleShape) {
     HandleShape[HandleShape["Circle"] = 0] = "Circle";
     HandleShape[HandleShape["Square"] = 1] = "Square";
-})(HandleShape || (exports.HandleShape = HandleShape = {}));
+})(HandleShape || (HandleShape = {}));
+var HandleAction;
+(function (HandleAction) {
+    HandleAction["ResizeXY"] = "resize-xy";
+    HandleAction["Rotate"] = "rotate";
+    HandleAction["ResizeX"] = "resize-x";
+    HandleAction["ResizeY"] = "resize-y";
+})(HandleAction || (exports.HandleAction = HandleAction = {}));
 exports.handleSize = 30;
 class SelectionHandle {
-    constructor(shape, parentSide, parent, viewport, onDragStart, onDragUpdate, onDragEnd) {
-        this.shape = shape;
-        this.parentSide = parentSide;
+    constructor(presentation, parent, viewport, onDragStart, onDragUpdate, onDragEnd) {
+        this.presentation = presentation;
         this.parent = parent;
         this.viewport = viewport;
         this.onDragStart = onDragStart;
@@ -21,8 +27,20 @@ class SelectionHandle {
         this.onDragEnd = onDragEnd;
         this.dragLastPos = null;
         this.element = document.createElement('div');
-        this.element.classList.add(`${SelectionTool_1.cssPrefix}handle`);
-        switch (shape) {
+        this.element.classList.add(`${SelectionTool_1.cssPrefix}handle`, `${SelectionTool_1.cssPrefix}${presentation.action}`);
+        this.parentSide = presentation.side;
+        const icon = presentation.icon;
+        if (icon) {
+            this.element.appendChild(icon);
+            icon.classList.add('icon');
+        }
+        if (presentation.action === HandleAction.Rotate) {
+            this.shape = HandleShape.Circle;
+        }
+        else {
+            this.shape = HandleShape.Square;
+        }
+        switch (this.shape) {
             case HandleShape.Circle:
                 this.element.classList.add(`${SelectionTool_1.cssPrefix}circle`);
                 break;
@@ -30,7 +48,7 @@ class SelectionHandle {
                 this.element.classList.add(`${SelectionTool_1.cssPrefix}square`);
                 break;
             default:
-                (0, assertions_1.assertUnreachable)(shape);
+                (0, assertions_1.assertUnreachable)(this.shape);
         }
         this.updatePosition();
     }

package/dist/cjs/tools/SelectionTool/SelectionTool.js

@@ -33,6 +33,11 @@ class SelectionTool extends BaseTool_1.default {
             // The selection box could be using the wet ink display if its transformation
             // hasn't been finalized yet. Clear before updating the UI.
             this.editor.clearWetInk();
+            // If not currently selecting, ensure that the selection box
+            // is large enough.
+            if (!this.expandingSelectionBox) {
+                this.selectionBox?.padRegion();
+            }
             this.selectionBox?.updateUI();
         });
         this.editor.handleKeyEventsFrom(this.handleOverlay);

package/dist/cjs/tools/SoundUITool.d.ts

@@ -14,6 +14,7 @@ export default class SoundUITool extends BaseTool {
     private toggleButton;
     private toggleButtonContainer;
     constructor(editor: Editor, description: string);
+    canReceiveInputInReadOnlyEditor(): boolean;
     private updateToggleButtonText;
     setEnabled(enabled: boolean): void;
     onKeyPress(event: KeyPressEvent): boolean;

package/dist/cjs/tools/SoundUITool.js

@@ -105,6 +105,9 @@ class SoundUITool extends BaseTool_1.default {
         this.updateToggleButtonText();
         editor.createHTMLOverlay(this.toggleButtonContainer);
     }
+    canReceiveInputInReadOnlyEditor() {
+        return true;
+    }
     updateToggleButtonText() {
         const containerEnabledClass = 'sound-ui-tool-enabled';
         if (this.isEnabled()) {
@@ -118,7 +121,7 @@ class SoundUITool extends BaseTool_1.default {
     }
     setEnabled(enabled) {
         super.setEnabled(enabled);
-        if (!enabled) {
+        if (!this.isEnabled()) {
             this.soundFeedback?.close();
             this.soundFeedback = null;
         }

package/dist/cjs/tools/TextTool.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const TextComponent_1 = __importDefault(require("../components/TextComponent"));
-const EditorImage_1 = __importDefault(require("../EditorImage"));
+const EditorImage_1 = __importDefault(require("../image/EditorImage"));
 const math_1 = require("@js-draw/math");
 const Pointer_1 = require("../Pointer");
 const types_1 = require("../types");
@@ -193,7 +193,7 @@ class TextTool extends BaseTool_1.default {
     }
     setEnabled(enabled) {
         super.setEnabled(enabled);
-        if (!enabled) {
+        if (!this.isEnabled()) {
             this.flushInput();
         }
         this.textEditOverlay.style.display = enabled ? 'block' : 'none';

package/dist/cjs/tools/ToolController.d.ts

@@ -9,6 +9,7 @@ export default class ToolController implements InputEventListener {
     private activeTool;
     private primaryToolGroup;
     private inputPipeline;
+    private isEditorReadOnly;
     /** @internal */
     constructor(editor: Editor, localization: ToolLocalization);
     setTools(tools: BaseTool[], primaryToolGroup?: ToolEnabledGroup): void;
@@ -29,4 +30,5 @@ export default class ToolController implements InputEventListener {
      */
     addInputMapper(mapper: InputMapper): void;
     getMatchingTools<Type extends BaseTool>(type: new (...args: any[]) => Type): Type[];
+    onEditorDestroyed(): void;
 }

package/dist/cjs/tools/ToolController.js

@@ -51,6 +51,7 @@ class ToolController {
     /** @internal */
     constructor(editor, localization) {
         this.activeTool = null;
+        this.isEditorReadOnly = editor.isReadOnlyReactiveValue();
         this.inputPipeline = new InputPipeline_1.default();
         this.inputPipeline.setEmitListener(event => this.onEventInternal(event));
         const primaryToolGroup = new ToolEnabledGroup_1.default();
@@ -135,6 +136,10 @@ class ToolController {
     }
     // @internal use `dispatchEvent` rather than calling `onEvent` directly.
     onEventInternal(event) {
+        const isEditorReadOnly = this.isEditorReadOnly.get();
+        const canToolReceiveInput = (tool) => {
+            return tool.isEnabled() && (!isEditorReadOnly || tool.canReceiveInputInReadOnlyEditor());
+        };
         let handled = false;
         if (event.kind === inputEvents_1.InputEvtType.PointerDownEvt) {
             let canOnlySendToActiveTool = false;
@@ -145,7 +150,7 @@ class ToolController {
                 if (canOnlySendToActiveTool && tool !== this.activeTool) {
                     continue;
                 }
-                if (tool.isEnabled() && tool.onEvent(event)) {
+                if (canToolReceiveInput(tool) && tool.onEvent(event)) {
                     if (this.activeTool !== tool) {
                         this.activeTool?.onEvent({ kind: inputEvents_1.InputEvtType.GestureCancelEvt });
                     }
@@ -179,7 +184,7 @@ class ToolController {
         }
         else {
             for (const tool of this.tools) {
-                if (!tool.isEnabled()) {
+                if (!canToolReceiveInput(tool)) {
                     continue;
                 }
                 handled = tool.onEvent(event);
@@ -213,5 +218,11 @@ class ToolController {
     getMatchingTools(type) {
         return this.tools.filter(tool => tool instanceof type);
     }
+    // @internal
+    onEditorDestroyed() {
+        for (const tool of this.tools) {
+            tool.onDestroy();
+        }
+    }
 }
 exports.default = ToolController;

package/dist/cjs/tools/ToolSwitcherShortcut.d.ts

@@ -12,5 +12,6 @@ import BaseTool from './BaseTool';
 export default class ToolSwitcherShortcut extends BaseTool {
     private editor;
     constructor(editor: Editor);
+    canReceiveInputInReadOnlyEditor(): boolean;
     onKeyPress({ key }: KeyPressEvent): boolean;
 }

package/dist/cjs/tools/ToolSwitcherShortcut.js

@@ -17,6 +17,9 @@ class ToolSwitcherShortcut extends BaseTool_1.default {
         super(editor.notifier, editor.localization.changeTool);
         this.editor = editor;
     }
+    canReceiveInputInReadOnlyEditor() {
+        return true;
+    }
     // @internal
     onKeyPress({ key }) {
         const toolController = this.editor.toolController;

package/dist/cjs/types.d.ts

@@ -16,12 +16,13 @@ export declare enum EditorEventType {
     ViewportChanged = 7,
     DisplayResized = 8,
     SelectionUpdated = 9,
+    ReadOnlyModeToggled = 10,
     /** @internal */
-    ColorPickerToggled = 10,
+    ColorPickerToggled = 11,
     /** @internal */
-    ColorPickerColorSelected = 11,
+    ColorPickerColorSelected = 12,
     /** @deprecated @internal */
-    ToolbarDropdownShown = 12
+    ToolbarDropdownShown = 13
 }
 export declare enum UndoEventType {
     CommandDone = 0,
@@ -66,6 +67,10 @@ export interface SelectionUpdated {
     readonly selectedComponents: AbstractComponent[];
     readonly tool: BaseTool;
 }
+export interface ReadOnlyToggled {
+    readonly kind: EditorEventType.ReadOnlyModeToggled;
+    readonly editorIsReadOnly: boolean;
+}
 export interface ColorPickerToggled {
     readonly kind: EditorEventType.ColorPickerToggled;
     readonly open: boolean;
@@ -79,7 +84,7 @@ export interface ToolbarDropdownShownEvent {
     readonly fromToplevelDropdown: boolean;
     readonly layoutManager: WidgetContentLayoutManager;
 }
-export type EditorEventDataType = EditorToolEvent | EditorObjectEvent | EditorViewportChangedEvent | DisplayResizedEvent | EditorUndoStackUpdated | CommandDoneEvent | CommandUndoneEvent | SelectionUpdated | ColorPickerToggled | ColorPickerColorSelected | ToolbarDropdownShownEvent;
+export type EditorEventDataType = EditorToolEvent | EditorObjectEvent | EditorViewportChangedEvent | DisplayResizedEvent | EditorUndoStackUpdated | CommandDoneEvent | CommandUndoneEvent | SelectionUpdated | ReadOnlyToggled | ColorPickerToggled | ColorPickerColorSelected | ToolbarDropdownShownEvent;
 export type OnProgressListener = (amountProcessed: number, totalToProcess: number) => Promise<void> | null | void;
 export type ComponentAddedListener = (component: AbstractComponent) => Promise<void> | void;
 export type OnDetermineExportRectListener = (exportRect: Rect2, options?: {

package/dist/cjs/types.js

@@ -14,12 +14,13 @@ var EditorEventType;
     EditorEventType[EditorEventType["ViewportChanged"] = 7] = "ViewportChanged";
     EditorEventType[EditorEventType["DisplayResized"] = 8] = "DisplayResized";
     EditorEventType[EditorEventType["SelectionUpdated"] = 9] = "SelectionUpdated";
+    EditorEventType[EditorEventType["ReadOnlyModeToggled"] = 10] = "ReadOnlyModeToggled";
     /** @internal */
-    EditorEventType[EditorEventType["ColorPickerToggled"] = 10] = "ColorPickerToggled";
+    EditorEventType[EditorEventType["ColorPickerToggled"] = 11] = "ColorPickerToggled";
     /** @internal */
-    EditorEventType[EditorEventType["ColorPickerColorSelected"] = 11] = "ColorPickerColorSelected";
+    EditorEventType[EditorEventType["ColorPickerColorSelected"] = 12] = "ColorPickerColorSelected";
     /** @deprecated @internal */
-    EditorEventType[EditorEventType["ToolbarDropdownShown"] = 12] = "ToolbarDropdownShown";
+    EditorEventType[EditorEventType["ToolbarDropdownShown"] = 13] = "ToolbarDropdownShown";
 })(EditorEventType || (exports.EditorEventType = EditorEventType = {}));
 // Types of `EditorUndoStackUpdated` events.
 var UndoEventType;

package/dist/cjs/util/ReactiveValue.d.ts

@@ -55,7 +55,7 @@ export declare abstract class ReactiveValue<T> {
 }
 export declare abstract class MutableReactiveValue<T> extends ReactiveValue<T> {
     /**
-     * Changes the value of this and fires all update listeners.
+     * Changes the value of this and, if different, fires all update listeners.
      *
      * @see {@link onUpdate}
      */

package/dist/cjs/util/ReactiveValue.js

@@ -59,7 +59,7 @@ class ReactiveValue {
      */
     static fromCallback(callback, sourceValues) {
         const result = new ReactiveValueImpl(callback());
-        const resultRef = window.WeakRef ? new WeakRef(result) : { deref: () => result };
+        const resultRef = window.WeakRef ? new window.WeakRef(result) : { deref: () => result };
         for (const value of sourceValues) {
             const listener = value.onUpdate(() => {
                 // Use resultRef to allow `result` to be garbage collected
@@ -98,7 +98,7 @@ exports.ReactiveValue = ReactiveValue;
 class MutableReactiveValue extends ReactiveValue {
     static fromProperty(sourceValue, propertyName) {
         const child = ReactiveValue.fromInitialValue(sourceValue.get()[propertyName]);
-        const childRef = window.WeakRef ? new WeakRef(child) : { deref: () => child };
+        const childRef = window.WeakRef ? new window.WeakRef(child) : { deref: () => child };
         // When the source is updated...
         const sourceListener = sourceValue.onUpdate(newValue => {
             const childValue = childRef.deref();

package/dist/cjs/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
-    number: '1.3.0',
+    number: '1.4.0',
 };

package/dist/mjs/Editor.d.ts

@@ -1,4 +1,4 @@
-import EditorImage from './EditorImage';
+import EditorImage from './image/EditorImage';
 import ToolController from './tools/ToolController';
 import { EditorNotifier, ImageLoader } from './types';
 import { HTMLPointerEventFilter, InputEvtType } from './inputEvents';
@@ -16,6 +16,7 @@ import KeyBinding from './shortcuts/KeyBinding';
 import AbstractToolbar from './toolbar/AbstractToolbar';
 import RenderablePathSpec from './rendering/RenderablePathSpec';
 import { AboutDialogEntry } from './dialogs/makeAboutDialog';
+import ReactiveValue, { MutableReactiveValue } from './util/ReactiveValue';
 /**
  * Provides settings to an instance of an editor. See the Editor {@link Editor.constructor}.
  *
@@ -152,6 +153,7 @@ export declare class Editor {
     private accessibilityAnnounceArea;
     private accessibilityControlArea;
     private eventListenerTargets;
+    private readOnly;
     private settings;
     /**
      * @example
@@ -269,6 +271,13 @@ export declare class Editor {
      * passed to the editor.
      */
     handleKeyEventsFrom(elem: HTMLElement, filter?: (event: KeyboardEvent) => boolean): void;
+    /**
+     * Attempts to prevent **user-triggered** events from modifying
+     * the content of the image.
+     */
+    setReadOnly(readOnly: boolean): void;
+    isReadOnlyReactiveValue(): ReactiveValue<boolean>;
+    isReadOnly(): MutableReactiveValue<boolean>;
     /** `apply` a command. `command` will be announced for accessibility. */
     dispatch(command: Command, addToHistory?: boolean): void | Promise<void>;
     /**
@@ -386,10 +395,31 @@ export declare class Editor {
     /**
      * Converts the editor's content into an SVG image.
      *
+     * If the output SVG has width or height less than `options.minDimension`, its size
+     * will be increased.
+     *
      * @see
      * {@link SVGRenderer}
      */
-    toSVG(): SVGElement;
+    toSVG(options?: {
+        minDimension?: number;
+    }): SVGElement;
+    /**
+     * Converts the editor's content into an SVG image in an asynchronous,
+     * but **potentially lossy** way.
+     *
+     * **Warning**: If the image is being edited during an async rendering, edited components
+     * may not be rendered.
+     *
+     * Like {@link toSVG}, but can be configured to briefly pause after processing every
+     * `pauseAfterCount` items. This can prevent the editor from becoming unresponsive
+     * when saving very large images.
+     */
+    toSVGAsync(options?: {
+        minDimension?: number;
+        pauseAfterCount?: number;
+        onProgress?: (processedCountInLayer: number, totalToProcessInLayer: number) => Promise<void | boolean>;
+    }): Promise<SVGElement>;
     /**
      * Load editor data from an `ImageLoader` (e.g. an {@link SVGLoader}).
      *
@@ -435,7 +465,10 @@ export declare class Editor {
      * Shows an information dialog with legal notices.
      */
     showAboutDialog(): void;
-    /** Removes and destroys the editor */
+    /**
+     * Removes and **destroys** the editor. The editor cannot be added to a parent
+     * again after calling this method.
+     */
     remove(): void;
 }
 export default Editor;