lucid-extension-sdk 0.0.196 → 0.0.198

package/commandtypes.d.ts

@@ -101,6 +101,7 @@ export declare const enum CommandName {
     ListTextAreas = "lta",
     LoadBlockClasses = "lbc",
     LogForTestCase = "log",
+    MeasureText = "mt",
     OffsetItems = "oi",
     PatchDataItems = "pdi",
     Prompt = "p",
@@ -464,6 +465,10 @@ export type CommandArgs = {
         query: JsonSerializable;
         result: JsonSerializable;
     };
+    [CommandName.MeasureText]: {
+        query: MeasureTextQuery;
+        result: MeasureTextResult;
+    };
     [CommandName.OffsetItems]: {
         query: OffsetItemsQuery;
         result: OffsetItemsResult;
@@ -1163,6 +1168,20 @@ export type ListTextAreasQuery = string;
 export type ListTextAreasResult = string[];
 export type LoadBlockClassesQuery = string[];
 export type LoadBlockClassesResult = Promise<undefined>;
+export type MeasureTextQuery = {
+    /** ID of the element to measure text area */
+    'id': string;
+    /** Name of the text area to measure */
+    'n': string;
+    /** Max width for giving text area*/
+    'w': number;
+};
+export type MeasureTextResult = {
+    /** Text area width */
+    'w': number;
+    /** Text area height */
+    'h': number;
+};
 export type OffsetItemsQuery = {
     /** IDs of the items (blocks, lines, groups) to move */
     'ids': string[];

package/commandtypes.js

@@ -81,6 +81,7 @@ exports.commandTitles = new Map([
     ["lta" /* CommandName.ListTextAreas */, 'ListTextAreas'],
     ["lbc" /* CommandName.LoadBlockClasses */, 'LoadBlockClasses'],
     ["log" /* CommandName.LogForTestCase */, 'LogForTestCase'],
+    ["mt" /* CommandName.MeasureText */, 'MeasureText'],
     ["oi" /* CommandName.OffsetItems */, 'OffsetItems'],
     ["pdi" /* CommandName.PatchDataItems */, 'PatchDataItems'],
     ["p" /* CommandName.Prompt */, 'Prompt'],

package/document/imagedefinition.d.ts

@@ -0,0 +1,15 @@
+import { SimpleImageFill } from '../core/properties/fillcolor';
+import { Box } from '../math';
+/**
+ * The information required to create a new image block on the current document
+ */
+export interface ImageDefinition {
+    /**
+     * The initial location and size of the block on the page.
+     */
+    boundingBox: Box;
+    /**
+     * Settings for using an image as the fill style of a block.
+     */
+    fillStyle: SimpleImageFill;
+}

package/document/imagedefinition.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/document/itemproxy.d.ts

@@ -65,6 +65,14 @@ export declare class ItemProxy extends ElementProxy {
      * @param offset The amount to offset
      */
     offset(type: LinearOffsetType, offset: Point): void;
+    /**
+     * Measure the amount of space necessary to render the text in the given text area, given a
+     * width to measure that text within.
+     * @param name Name of the text area whose content we should measure
+     * @param maxWidth Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.
+     * @returns The size of rectangle necessary to render this text area's content.
+     */
+    measureText(name: string, maxWidth: number): import("../commandtypes").MeasureTextResult;
     /**
      * Delete this item from the document
      */

package/document/itemproxy.js

@@ -102,6 +102,16 @@ class ItemProxy extends elementproxy_1.ElementProxy {
     offset(type, offset) {
         this.client.sendCommand("oi" /* CommandName.OffsetItems */, { 'ids': [this.id], 't': type, 'o': offset });
     }
+    /**
+     * Measure the amount of space necessary to render the text in the given text area, given a
+     * width to measure that text within.
+     * @param name Name of the text area whose content we should measure
+     * @param maxWidth Width of the area in which to measure this text. The result will usually be no wider than this, but if a single word is long enough to go beyond this maxWidth, the width of that word will be returned.
+     * @returns The size of rectangle necessary to render this text area's content.
+     */
+    measureText(name, maxWidth) {
+        return this.client.sendCommand("mt" /* CommandName.MeasureText */, { 'id': this.id, 'n': name, 'w': maxWidth });
+    }
     /**
      * Delete this item from the document
      */

package/document/pageproxy.d.ts

@@ -6,6 +6,7 @@ import { BlockProxy } from './blockproxy';
 import { RuleProxy } from './documentelement/ruleproxy';
 import { ElementProxy } from './elementproxy';
 import { GroupProxy } from './groupproxy';
+import { ImageDefinition } from './imagedefinition';
 import { LineDefinition } from './linedefinition';
 import { LineProxy } from './lineproxy';
 import { MapProxy } from './mapproxy';
@@ -72,6 +73,7 @@ export declare class PageProxy extends ElementProxy {
      * @returns The added line
      */
     addLine(def: LineDefinition): LineProxy;
+    addImage(def: ImageDefinition): Promise<BlockProxy>;
     /**
      * Updates the page of this page
      * @param title The new title for this page

package/document/pageproxy.js

@@ -113,6 +113,10 @@ class PageProxy extends elementproxy_1.ElementProxy {
         line.setEndpoint2(def.endpoint2);
         return line;
     }
+    async addImage(def) {
+        await this.client.loadBlockClasses(['UserImage2Block']);
+        return this.addBlock(Object.assign({ className: 'UserImage2Block' }, def));
+    }
     /**
      * Updates the page of this page
      * @param title The new title for this page

package/package.json

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