@leapfrog/interactive-canvas 2.0.13 → 2.0.14

package/dist/interactive-canvas.interface.d.ts

@@ -1,297 +1,297 @@
-import { Observable } from "rxjs";
-import { IImage } from "./object/impl/image";
-import { IText } from "./object/impl/text";
-import { IRectangle } from "./object/impl/rectangle";
-import { ICutoff } from "./object/impl/cutoff";
-import { ILayoutManager } from "./layout/layout-manager.interface";
-import { IBorder } from "./object/impl/border";
-import { LayoutManager } from "./layout/layout-manager.enum";
-import { IVerticalRule } from "./object/impl/vertical-rule";
-import { IHorizontalRule } from "./object/impl/horizontal-rule";
-import { IFontLibrary } from "./font/font-library.interface";
-import { ICanvasProfile } from "./profile/canvas-profile.interface";
-import { ICanvasDimensionRestrictions } from "./types/canvas-dimension-restrictions.interface";
-import { IRect } from "./types/rect.interface";
-import { ICanvasObject } from "./object/canvas-object.interface";
-import { ICanvasDimensions } from "./types/canvas-dimensions.interface";
-import { ISelectionData } from "./types/selection-data.interface";
-import { ICanvasState } from "./types/canvas-state.interface";
-import { AbstractCanvasObject } from "./object/abstract-canvas-object";
-import { ObjectType } from "./types/object-type.enum";
-import { fabric } from "fabric";
-import { IRichText } from "./object/impl/rich-text";
-import { IBackgroundImage } from "./object/impl/background-image";
-/**
- * New leapfrog canvas implementation c. 2019.
- */
-export interface IInteractiveCanvas {
-    /**
-     * True if the canvas is operating in a headless mode.
-     */
-    readonly headless: boolean;
-    /**
-     * Get the canvas font library.
-     */
-    getFontLibrary(): IFontLibrary;
-    /**
-     * Get the current canvas profile.
-     * The profile determines what operations are permitted, such as moving or scaling components.
-     */
-    getProfile(): ICanvasProfile;
-    /**
-     * Get an observable of the current canvas profile.
-     */
-    getProfile$(): Observable<ICanvasProfile>;
-    /**
-     * Set the canvas profile.
-     * @param profile New profile.
-     */
-    setProfile(profile: ICanvasProfile): void;
-    /**
-     * Get the current layout manager.
-     * The layout manager controls how elements on the canvas are laid out.
-     */
-    getLayoutManager(): ILayoutManager;
-    /**
-     * Get an observable of the current layout manager.
-     */
-    getLayoutManager$(): Observable<ILayoutManager>;
-    /**
-     * Set the layout manager.
-     * @param layoutManager New layout manager.
-     */
-    setLayoutManager(layoutManager: LayoutManager): void;
-    /**
-     * Get the current canvas background color.
-     */
-    getBackgroundColor(): string;
-    /**
-     * Get an observable of the current background color.
-     */
-    getBackgroundColor$(): Observable<string>;
-    /**
-     * Set the canvas background color.
-     * @param color New color.
-     */
-    setBackgroundColor(color: string): void;
-    /**
-     * Get the current canvas dimensions.
-     */
-    getDimensions(): ICanvasDimensions;
-    /**
-     * Get the current canvas base dimensions.
-     */
-    getBaseDimensions(): ICanvasDimensions;
-    /**
-     * Get an observable of the current canvas dimensions.
-     */
-    getDimensions$(): Observable<ICanvasDimensions>;
-    /**
-     * Set new canvas dimensions.
-     * @param dimensions New dimensions.
-     */
-    setDimensions(dimensions: ICanvasDimensions): void;
-    /**
-     * Set new canvas base dimensions. Automatic resize will occur relative to these base dimensions.
-     * @param dimensions New dimensions.
-     */
-    setBaseDimensions(dimensions: ICanvasDimensions): void;
-    /**
-     * Get an observable of any rejected dimension changes.
-     */
-    getDimensionChangeRejections$(): Observable<ICanvasDimensions>;
-    /**
-     * Set restrictions on canvas dimensions.
-     * @param restrictions Optional restrictions.
-     */
-    setDimensionRestrictions(restrictions: ICanvasDimensionRestrictions): void;
-    /**
-     * Get an observable of the canvas dimension restrictions.
-     */
-    getDimensionsRestrictions$(): Observable<ICanvasDimensionRestrictions>;
-    /**
-     * Get canvas dimension restrictions.
-     */
-    getDimensionsRestrictions(): ICanvasDimensionRestrictions;
-    /**
-     * Get the size of the canvas margin (the area occupied by borders/cutoff rules).
-     */
-    getMargin(): IRect;
-    /**
-     * Get the current canvas zoom factor.
-     */
-    getZoom(): number;
-    /**
-     * Get an observable of the current canvas zoom factor.
-     */
-    getZoom$(): Observable<number>;
-    /**
-     * Set a new canvas zoom factor.
-     * @param zoom Zoom factor.
-     */
-    setZoom(zoom: number): void;
-    /**
-     * Get the current canvas object list.
-     */
-    getObjects(): ICanvasObject[];
-    /**
-     * Get an observable of the current canvas object list.
-     */
-    getObjects$(): Observable<ICanvasObject[]>;
-    /**
-     * Remove an object from the canvas.
-     * @param object The object to remove.
-     */
-    removeObject(object: ICanvasObject): void;
-    /**
-     * Add an image object to the canvas.
-     * @param imageUrl Url for image content.
-     */
-    addImageObject(imageUrl: string): Promise<IImage>;
-    /**
-     * Add a text object to the canvas.
-     */
-    addTextObject(): Promise<IText>;
-    /**
-     * Add a rich text element to the canvas.
-     * @param imageUrl Url for text-rendered-as-image content.
-     * @param htmlContent Rich-text content as HTML.
-     */
-    addRichTextObject(imageUrl: string, htmlContent: string): Promise<IRichText>;
-    /**
-     * Add a rectangle object to the canvas.
-     */
-    addRectangleObject(): Promise<IRectangle>;
-    /**
-     * Add a rectangle object to the canvas.
-     */
-    addCutoffObject(): Promise<ICutoff>;
-    /**
-     * Add a border object to the canvas.
-     */
-    addBorderObject(): Promise<IBorder>;
-    /**
-     * Add a vertical rule object to the canvas.
-     */
-    addVerticalRuleObject(): Promise<IVerticalRule>;
-    /**
-     * Add a horizontal rule object to the canvas.
-     */
-    addHorizontalRuleObject(): Promise<IHorizontalRule>;
-    /**
-     * Add a background image object to the canvas.
-     * @param imageUrl Url for image content.
-     */
-    addBackgroundImageObject(imageUrl: string): Promise<IBackgroundImage>;
-    /**
-     * Set the data used to prefill text into the canvas.
-     * @param data Prefill data.
-     */
-    setPrefillData(data: {
-        [id: string]: string;
-    }): void;
-    /**
-     * Distribute text and image objects equally along the vertical axis.s
-     */
-    distributeObjectsVertically(): void;
-    /**
-     * Get data on the current selection.
-     */
-    getSelection(): ISelectionData;
-    /**
-     * Get an observable of the current selection data.
-     */
-    getSelection$(): Observable<ISelectionData>;
-    /**
-     * Select a field.
-     * @param field The field to select.
-     */
-    select(field: ICanvasObject): void;
-    /**
-     * Deselects any selected fields.
-     */
-    clearSelection(): void;
-    /**
-     * Enable/disable multi select.
-     * @param value value.
-     */
-    setMultiSelect(value: boolean): void;
-    /**
-     * Clear the canvas.
-     */
-    clear(): void;
-    /**
-     * Serialize the canvas for saving.
-     * Returns an observable that will complete after the load process is finished.
-     */
-    save(): ICanvasState;
-    /**
-     * Load the canvas state from a previously {@link IInteractiveCanvas#save saved} state.
-     * @param canvasState Persisted canvas state.
-     */
-    load(canvasState: ICanvasState): Promise<void>;
-    /**
-     * Export the canvas to an SVG.
-     */
-    toSvg(): string;
-    /**
-     * Export the canvas to a DataUrl image.
-     * @param multiplier Multiply the image pixel density by this amount.
-     */
-    toImage(multiplier?: number): string;
-    /**
-     * Notify the canvas that the object list has changed.
-     */
-    notifyObjectListChanged(): void;
-    /**
-     * Notify the canvas that the text has changed.
-     */
-    notifyTextChanged(): void;
-    /**
-     * Notify the canvas that the margin has changed.
-     */
-    notifyMarginChanged(): void;
-    /**
-     * Sync the canvas object list with the underlying fabric object list.
-     */
-    syncObjectList(): void;
-    /**
-     * Redraw the canvas.
-     */
-    redraw(): void;
-    /**
-     * Get the internal objects list.
-     */
-    getObjectsInternal(): Array<AbstractCanvasObject<any>>;
-    /**
-     * Get objects by type.
-     * @param type Object type.
-     */
-    getObjectsByTypeInternal<T extends AbstractCanvasObject<any>>(type: ObjectType): T[];
-    /**
-     * Get all objects of given types.
-     * @param types The types.
-     */
-    getObjectsByTypesInternal(...types: ObjectType[]): Array<AbstractCanvasObject<any>>;
-    /**
-     * Remove an underlying fabric object.
-     * @param obj The object.
-     */
-    removeFabricObject(obj: fabric.Object): void;
-    /**
-     * Create a PNG stream of the canvas. Only works on headless canvas.
-     */
-    createPNGStream(): any;
-    /**
-     * Save the current state as an undo point.
-     */
-    registerUndoState(): void;
-    /**
-     * Revert the canvas state one entry.
-     */
-    undo(): Promise<void>;
-    /**
-     * Revert the canvas state one entry.
-     */
-    redo(): Promise<void>;
-}
+import { Observable } from "rxjs";
+import { IImage } from "./object/impl/image";
+import { IText } from "./object/impl/text";
+import { IRectangle } from "./object/impl/rectangle";
+import { ICutoff } from "./object/impl/cutoff";
+import { ILayoutManager } from "./layout/layout-manager.interface";
+import { IBorder } from "./object/impl/border";
+import { LayoutManager } from "./layout/layout-manager.enum";
+import { IVerticalRule } from "./object/impl/vertical-rule";
+import { IHorizontalRule } from "./object/impl/horizontal-rule";
+import { IFontLibrary } from "./font/font-library.interface";
+import { ICanvasProfile } from "./profile/canvas-profile.interface";
+import { ICanvasDimensionRestrictions } from "./types/canvas-dimension-restrictions.interface";
+import { IRect } from "./types/rect.interface";
+import { ICanvasObject } from "./object/canvas-object.interface";
+import { ICanvasDimensions } from "./types/canvas-dimensions.interface";
+import { ISelectionData } from "./types/selection-data.interface";
+import { ICanvasState } from "./types/canvas-state.interface";
+import { AbstractCanvasObject } from "./object/abstract-canvas-object";
+import { ObjectType } from "./types/object-type.enum";
+import { fabric } from "fabric";
+import { IRichText } from "./object/impl/rich-text";
+import { IBackgroundImage } from "./object/impl/background-image";
+/**
+ * New leapfrog canvas implementation c. 2019.
+ */
+export interface IInteractiveCanvas {
+    /**
+     * True if the canvas is operating in a headless mode.
+     */
+    readonly headless: boolean;
+    /**
+     * Get the canvas font library.
+     */
+    getFontLibrary(): IFontLibrary;
+    /**
+     * Get the current canvas profile.
+     * The profile determines what operations are permitted, such as moving or scaling components.
+     */
+    getProfile(): ICanvasProfile;
+    /**
+     * Get an observable of the current canvas profile.
+     */
+    getProfile$(): Observable<ICanvasProfile>;
+    /**
+     * Set the canvas profile.
+     * @param profile New profile.
+     */
+    setProfile(profile: ICanvasProfile): void;
+    /**
+     * Get the current layout manager.
+     * The layout manager controls how elements on the canvas are laid out.
+     */
+    getLayoutManager(): ILayoutManager;
+    /**
+     * Get an observable of the current layout manager.
+     */
+    getLayoutManager$(): Observable<ILayoutManager>;
+    /**
+     * Set the layout manager.
+     * @param layoutManager New layout manager.
+     */
+    setLayoutManager(layoutManager: LayoutManager): void;
+    /**
+     * Get the current canvas background color.
+     */
+    getBackgroundColor(): string;
+    /**
+     * Get an observable of the current background color.
+     */
+    getBackgroundColor$(): Observable<string>;
+    /**
+     * Set the canvas background color.
+     * @param color New color.
+     */
+    setBackgroundColor(color: string): void;
+    /**
+     * Get the current canvas dimensions.
+     */
+    getDimensions(): ICanvasDimensions;
+    /**
+     * Get the current canvas base dimensions.
+     */
+    getBaseDimensions(): ICanvasDimensions;
+    /**
+     * Get an observable of the current canvas dimensions.
+     */
+    getDimensions$(): Observable<ICanvasDimensions>;
+    /**
+     * Set new canvas dimensions.
+     * @param dimensions New dimensions.
+     */
+    setDimensions(dimensions: ICanvasDimensions): void;
+    /**
+     * Set new canvas base dimensions. Automatic resize will occur relative to these base dimensions.
+     * @param dimensions New dimensions.
+     */
+    setBaseDimensions(dimensions: ICanvasDimensions): void;
+    /**
+     * Get an observable of any rejected dimension changes.
+     */
+    getDimensionChangeRejections$(): Observable<ICanvasDimensions>;
+    /**
+     * Set restrictions on canvas dimensions.
+     * @param restrictions Optional restrictions.
+     */
+    setDimensionRestrictions(restrictions: ICanvasDimensionRestrictions): void;
+    /**
+     * Get an observable of the canvas dimension restrictions.
+     */
+    getDimensionsRestrictions$(): Observable<ICanvasDimensionRestrictions>;
+    /**
+     * Get canvas dimension restrictions.
+     */
+    getDimensionsRestrictions(): ICanvasDimensionRestrictions;
+    /**
+     * Get the size of the canvas margin (the area occupied by borders/cutoff rules).
+     */
+    getMargin(): IRect;
+    /**
+     * Get the current canvas zoom factor.
+     */
+    getZoom(): number;
+    /**
+     * Get an observable of the current canvas zoom factor.
+     */
+    getZoom$(): Observable<number>;
+    /**
+     * Set a new canvas zoom factor.
+     * @param zoom Zoom factor.
+     */
+    setZoom(zoom: number): void;
+    /**
+     * Get the current canvas object list.
+     */
+    getObjects(): ICanvasObject[];
+    /**
+     * Get an observable of the current canvas object list.
+     */
+    getObjects$(): Observable<ICanvasObject[]>;
+    /**
+     * Remove an object from the canvas.
+     * @param object The object to remove.
+     */
+    removeObject(object: ICanvasObject): void;
+    /**
+     * Add an image object to the canvas.
+     * @param imageUrl Url for image content.
+     */
+    addImageObject(imageUrl: string): Promise<IImage>;
+    /**
+     * Add a text object to the canvas.
+     */
+    addTextObject(): Promise<IText>;
+    /**
+     * Add a rich text element to the canvas.
+     * @param imageUrl Url for text-rendered-as-image content.
+     * @param htmlContent Rich-text content as HTML.
+     */
+    addRichTextObject(imageUrl: string, htmlContent: string): Promise<IRichText>;
+    /**
+     * Add a rectangle object to the canvas.
+     */
+    addRectangleObject(): Promise<IRectangle>;
+    /**
+     * Add a rectangle object to the canvas.
+     */
+    addCutoffObject(): Promise<ICutoff>;
+    /**
+     * Add a border object to the canvas.
+     */
+    addBorderObject(): Promise<IBorder>;
+    /**
+     * Add a vertical rule object to the canvas.
+     */
+    addVerticalRuleObject(): Promise<IVerticalRule>;
+    /**
+     * Add a horizontal rule object to the canvas.
+     */
+    addHorizontalRuleObject(): Promise<IHorizontalRule>;
+    /**
+     * Add a background image object to the canvas.
+     * @param imageUrl Url for image content.
+     */
+    addBackgroundImageObject(imageUrl: string): Promise<IBackgroundImage>;
+    /**
+     * Set the data used to prefill text into the canvas.
+     * @param data Prefill data.
+     */
+    setPrefillData(data: {
+        [id: string]: string;
+    }): void;
+    /**
+     * Distribute text and image objects equally along the vertical axis.s
+     */
+    distributeObjectsVertically(): void;
+    /**
+     * Get data on the current selection.
+     */
+    getSelection(): ISelectionData;
+    /**
+     * Get an observable of the current selection data.
+     */
+    getSelection$(): Observable<ISelectionData>;
+    /**
+     * Select a field.
+     * @param field The field to select.
+     */
+    select(field: ICanvasObject): void;
+    /**
+     * Deselects any selected fields.
+     */
+    clearSelection(): void;
+    /**
+     * Enable/disable multi select.
+     * @param value value.
+     */
+    setMultiSelect(value: boolean): void;
+    /**
+     * Clear the canvas.
+     */
+    clear(): void;
+    /**
+     * Serialize the canvas for saving.
+     * Returns an observable that will complete after the load process is finished.
+     */
+    save(): ICanvasState;
+    /**
+     * Load the canvas state from a previously {@link IInteractiveCanvas#save saved} state.
+     * @param canvasState Persisted canvas state.
+     */
+    load(canvasState: ICanvasState): Promise<void>;
+    /**
+     * Export the canvas to an SVG.
+     */
+    toSvg(): string;
+    /**
+     * Export the canvas to a DataUrl image.
+     * @param multiplier Multiply the image pixel density by this amount.
+     */
+    toImage(multiplier?: number): string;
+    /**
+     * Notify the canvas that the object list has changed.
+     */
+    notifyObjectListChanged(): void;
+    /**
+     * Notify the canvas that the text has changed.
+     */
+    notifyTextChanged(): void;
+    /**
+     * Notify the canvas that the margin has changed.
+     */
+    notifyMarginChanged(): void;
+    /**
+     * Sync the canvas object list with the underlying fabric object list.
+     */
+    syncObjectList(): void;
+    /**
+     * Redraw the canvas.
+     */
+    redraw(): void;
+    /**
+     * Get the internal objects list.
+     */
+    getObjectsInternal(): Array<AbstractCanvasObject<any>>;
+    /**
+     * Get objects by type.
+     * @param type Object type.
+     */
+    getObjectsByTypeInternal<T extends AbstractCanvasObject<any>>(type: ObjectType): T[];
+    /**
+     * Get all objects of given types.
+     * @param types The types.
+     */
+    getObjectsByTypesInternal(...types: ObjectType[]): Array<AbstractCanvasObject<any>>;
+    /**
+     * Remove an underlying fabric object.
+     * @param obj The object.
+     */
+    removeFabricObject(obj: fabric.Object): void;
+    /**
+     * Create a PNG stream of the canvas. Only works on headless canvas.
+     */
+    createPNGStream(): any;
+    /**
+     * Save the current state as an undo point.
+     */
+    registerUndoState(): void;
+    /**
+     * Revert the canvas state one entry.
+     */
+    undo(): Promise<void>;
+    /**
+     * Revert the canvas state one entry.
+     */
+    redo(): Promise<void>;
+}