lucid-extension-sdk 0.0.219 → 0.0.220

package/document/imagedefinition.d.ts

@@ -1,6 +1,7 @@
 import { SimpleImageFill } from '../core/properties/fillcolor';
 import { StrokeStyle } from '../core/properties/strokestyle';
 import { Box } from '../math';
+import { BlockDefinition } from './blockdefinition';
 /**
  * The information required to create a new image block on the current document
  */
@@ -38,3 +39,7 @@ export interface ImageDefinition {
      */
     rotation?: number;
 }
+/**
+ * Turns an image definition into a block definition.
+ */
+export declare function imageToBlockDefinition(definition: ImageDefinition): BlockDefinition;

package/document/imagedefinition.js

@@ -1,2 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.imageToBlockDefinition = void 0;
+/**
+ * Turns an image definition into a block definition.
+ */
+function imageToBlockDefinition(definition) {
+    return {
+        className: 'UserImage2Block',
+        boundingBox: definition.boundingBox,
+        fillStyle: definition.fillStyle,
+        properties: {
+            opactiy: definition.opacity,
+            lineColor: definition.lineColor,
+            lineWidth: definition.lineWidth,
+            strokeStyle: definition.strokeStyle,
+            rounding: definition.rounding,
+            rotation: definition.rotation,
+        },
+    };
+}
+exports.imageToBlockDefinition = imageToBlockDefinition;

package/document/pageproxy.js

@@ -5,6 +5,7 @@ const commandtypes_1 = require("../commandtypes");
 const ruleproxy_1 = require("./documentelement/ruleproxy");
 const elementproxy_1 = require("./elementproxy");
 const groupproxy_1 = require("./groupproxy");
+const imagedefinition_1 = require("./imagedefinition");
 const lineproxy_1 = require("./lineproxy");
 const mapproxy_1 = require("./mapproxy");
 /**
@@ -121,19 +122,7 @@ class PageProxy extends elementproxy_1.ElementProxy {
      */
     async addImage(def) {
         await this.client.loadBlockClasses(['UserImage2Block']);
-        return this.addBlock({
-            className: 'UserImage2Block',
-            boundingBox: def.boundingBox,
-            fillStyle: def.fillStyle,
-            properties: {
-                opactiy: def.opacity,
-                lineColor: def.lineColor,
-                lineWidth: def.lineWidth,
-                strokeStyle: def.strokeStyle,
-                rounding: def.rounding,
-                rotation: def.rotation,
-            },
-        });
+        return this.addBlock((0, imagedefinition_1.imageToBlockDefinition)(def));
     }
     /**
      * Updates the page of this page

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.219",
+    "version": "0.0.220",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",

package/ui/viewport.d.ts

@@ -1,4 +1,5 @@
 import { BlockDefinition } from '../document/blockdefinition';
+import { ImageDefinition } from '../document/imagedefinition';
 import { ItemProxy } from '../document/itemproxy';
 import { PageProxy } from '../document/pageproxy';
 import { EditorClient } from '../editorclient';
@@ -102,11 +103,26 @@ export declare class Viewport {
      *  or undefined if the user cancels the drag interaction.
      */
     startDraggingNewBlock(definition: BlockDefinition): Promise<import("..").BlockProxy | undefined>;
+    /**
+     * Start an interaction of the current user dragging a new image onto the current page, exactly
+     * as if they started dragging that image out of the normal toolbox. At the time this function is
+     * called, the user's primary mouse button should be down (e.g. in a mousedown event handler).
+     *
+     * @param definition Definition of the image to create if and where the user drops it on-canvas
+     * @returns A promise resolving to a reference to the created image, if successfully dropped,
+     *  or undefined if the user cancels the drag interaction.
+     */
+    startDraggingNewImage(definition: ImageDefinition): Promise<import("..").BlockProxy | undefined>;
     /**
      * If startDraggingNewBlock has been called, and the drag-new-block interaction is still active,
      * cancel that interaction.
      */
     cancelDraggingNewBlock(): void;
+    /**
+     * If startDraggingNewImage has been called, and the drag-new-image interaction is still active,
+     * cancel that interaction.
+     */
+    cancelDraggingNewImage(): void;
     /**
      * After calling startDraggingNewBlock, call this to simulate the user moving the mouse at the
      * given location within the top-level browser window.

package/ui/viewport.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Viewport = void 0;
 const checks_1 = require("../core/checks");
 const fillcolor_1 = require("../core/properties/fillcolor");
+const imagedefinition_1 = require("../document/imagedefinition");
 const itemproxy_1 = require("../document/itemproxy");
 const pageproxy_1 = require("../document/pageproxy");
 const math_1 = require("../math");
@@ -185,6 +186,19 @@ class Viewport {
         });
         return maybeBlockId ? this.client.getBlockProxy(maybeBlockId) : undefined;
     }
+    /**
+     * Start an interaction of the current user dragging a new image onto the current page, exactly
+     * as if they started dragging that image out of the normal toolbox. At the time this function is
+     * called, the user's primary mouse button should be down (e.g. in a mousedown event handler).
+     *
+     * @param definition Definition of the image to create if and where the user drops it on-canvas
+     * @returns A promise resolving to a reference to the created image, if successfully dropped,
+     *  or undefined if the user cancels the drag interaction.
+     */
+    async startDraggingNewImage(definition) {
+        await this.client.loadBlockClasses(['UserImage2Block']);
+        return await this.startDraggingNewBlock((0, imagedefinition_1.imageToBlockDefinition)(definition));
+    }
     /**
      * If startDraggingNewBlock has been called, and the drag-new-block interaction is still active,
      * cancel that interaction.
@@ -192,6 +206,13 @@ class Viewport {
     cancelDraggingNewBlock() {
         this.client.sendCommand("cdc" /* CommandName.CancelDragBlockToCanvas */, undefined);
     }
+    /**
+     * If startDraggingNewImage has been called, and the drag-new-image interaction is still active,
+     * cancel that interaction.
+     */
+    cancelDraggingNewImage() {
+        this.cancelDraggingNewBlock();
+    }
     /**
      * After calling startDraggingNewBlock, call this to simulate the user moving the mouse at the
      * given location within the top-level browser window.