@leapfrog/interactive-canvas 2.0.14 → 2.0.15-beta-1

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

@@ -1,375 +1,375 @@
-import { BehaviorSubject, Observable, Subject } from "rxjs";
-import { ICutoff } from "./object/impl/cutoff";
-import { IRectangle } from "./object/impl/rectangle";
-import { IBorder } from "./object/impl/border";
-import { IImage } from "./object/impl/image";
-import { IText } from "./object/impl/text";
-import { ILayoutManager } from "./layout/layout-manager.interface";
-import { LayoutManager } from "./layout/layout-manager.enum";
-import { IVerticalRule } from "./object/impl/vertical-rule";
-import { IHorizontalRule } from "./object/impl/horizontal-rule";
-import { IInteractiveCanvas } from "./interactive-canvas.interface";
-import { ICanvasProfile } from "./profile/canvas-profile.interface";
-import { IFontLibrary } from "./font/font-library.interface";
-import { ICanvasDimensions } from "./types/canvas-dimensions.interface";
-import { ICanvasDimensionRestrictions } from "./types/canvas-dimension-restrictions.interface";
-import { AbstractCanvasObject } from "./object/abstract-canvas-object";
-import { IRect } from "./types/rect.interface";
-import { ObjectType } from "./types/object-type.enum";
-import { ICanvasObject } from "./object/canvas-object.interface";
-import { ISelectionData } from "./types/selection-data.interface";
-import { ICanvasState } from "./types/canvas-state.interface";
-import { ITextSelection } from "./mutator/mutable-text-style.interface";
-import { fabric } from "fabric";
-import { IRichText } from "./object/impl/rich-text";
-import { IBackgroundImage } from "./object/impl/background-image";
-import { IEvent } from "fabric/fabric-impl";
-export declare abstract class AbstractInteractiveCanvas implements IInteractiveCanvas {
-    fabric: any;
-    protected readonly fabricCanvas: fabric.Canvas;
-    protected devicePixelRatio: number;
-    protected readonly IMAGE_CAPTURE_COEFFICIENT: number;
-    abstract readonly headless: boolean;
-    protected readonly fontLibrary: IFontLibrary;
-    protected readonly profile$: BehaviorSubject<ICanvasProfile>;
-    protected readonly layoutManager$: BehaviorSubject<ILayoutManager>;
-    protected readonly backgroundColor$: BehaviorSubject<string>;
-    protected readonly dimensions$: BehaviorSubject<ICanvasDimensions>;
-    protected readonly dimensionRestrictions$: BehaviorSubject<ICanvasDimensionRestrictions>;
-    protected readonly dimensionChangeRejections$: Subject<ICanvasDimensions>;
-    protected readonly zoom$: BehaviorSubject<number>;
-    protected readonly objects$: BehaviorSubject<Array<AbstractCanvasObject<any>>>;
-    protected readonly selection$: BehaviorSubject<SelectionData>;
-    protected baseDimensions: ICanvasDimensions;
-    protected constructor(fabric: any, fabricCanvas: fabric.Canvas, devicePixelRatio: number);
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getFontLibrary(): IFontLibrary;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getProfile(): ICanvasProfile;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getProfile$(): Observable<ICanvasProfile>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setProfile(profile: ICanvasProfile): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getLayoutManager(): ILayoutManager;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getLayoutManager$(): Observable<ILayoutManager>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setLayoutManager(layoutManager: LayoutManager): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getBackgroundColor(): string;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getBackgroundColor$(): Observable<string>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setBackgroundColor(color?: string): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getDimensions(): ICanvasDimensions;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getBaseDimensions(): ICanvasDimensions;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getDimensions$(): Observable<ICanvasDimensions>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setDimensions(dimensions: ICanvasDimensions): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setBaseDimensions(dimensions: ICanvasDimensions): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getDimensionChangeRejections$(): Observable<ICanvasDimensions>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getDimensionsRestrictions(): ICanvasDimensionRestrictions;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getDimensionsRestrictions$(): Observable<ICanvasDimensionRestrictions>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setDimensionRestrictions(restrictions: ICanvasDimensionRestrictions): void;
-    getMargin(): IRect;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getZoom(): number;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getZoom$(): Observable<number>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setZoom(zoom: number): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getObjects(): ICanvasObject[];
-    /**
-     * Get the list of objects directly.
-     */
-    getObjectsInternal(): Array<AbstractCanvasObject<any>>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getObjectsByTypeInternal<T extends AbstractCanvasObject<any>>(type: ObjectType): T[];
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getObjectsByTypesInternal(...types: ObjectType[]): Array<AbstractCanvasObject<any>>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getObjects$(): Observable<ICanvasObject[]>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    removeObject(target: ICanvasObject): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    addImageObject(imageUrl: string): Promise<IImage>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    addTextObject(): Promise<IText>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    addRichTextObject(imageUrl: string, htmlContent: string): Promise<IRichText>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    addRectangleObject(): Promise<IRectangle>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    addCutoffObject(): Promise<ICutoff>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    addBorderObject(): Promise<IBorder>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    addVerticalRuleObject(): Promise<IVerticalRule>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    addHorizontalRuleObject(): Promise<IHorizontalRule>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    addBackgroundImageObject(imageUrl: string): Promise<IBackgroundImage>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setPrefillData(data: {
-        [id: string]: string;
-    }): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    distributeObjectsVertically(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getSelection(): ISelectionData;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getSelection$(): Observable<ISelectionData>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    select(object: ICanvasObject): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    clearSelection(): void;
-    setMultiSelect(value: boolean): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    clear(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    save(): ICanvasState;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    load(canvasState: ICanvasState): Promise<void>;
-    /**
-     * Another hack for bullet points... because they use canvas objects to render the bullets, they get saved when the canvas is persisted... and then loaded into a new canvas, but there's
-     * nothing linking them to the field that needs bullets, so they end up duplicating every time the canvas is saved/loaded. Since we don't use circles for anything else, this just
-     * deletes all circles on canvas load.
-     */
-    private removePersistedBullets;
-    /**
-     * Remove any slave objects persisted to the canvas; their master objects will recreate them.
-     */
-    private removeSlaveObjects;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    toSvg(): string;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    toImage(multiplier?: number): string;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    createPNGStream(): any;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    registerUndoState(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    undo(): Promise<void>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    redo(): Promise<void>;
-    /**
-     * Redraw the canvas.
-     */
-    redraw(): void;
-    syncObjectList(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    notifyObjectListChanged(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    notifyTextChanged(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    notifyMarginChanged(): void;
-    removeFabricObject(obj: any): void;
-    protected selectFabricObject(object: fabric.Object): void;
-    protected onTextChange(): void;
-    protected onObjectListChange(): void;
-    protected onDimensionsChange(): void;
-    protected onMarginChange(): void;
-    private bindFields;
-    private bindField;
-    private findFabricObject;
-    private findObject;
-    /**
-     * Reset zoom and canvas dimensions to 1:1 scale, execute a function, then return the canvas to
-     * the previous values.
-     * @param func Function to execute.
-     */
-    private executeWithNormalizedCanvas;
-    /**
-     * Update the actual dimensions of the canvas by multiplying the requested dimensions by the current zoom factor.
-     */
-    private updateCanvasDimensions;
-    protected onProfileChanged(profile: ICanvasProfile): void;
-    protected getFieldByCanvasObject?(object: any): AbstractCanvasObject<any> | null;
-    protected getFieldsByCanvasObject(objects: any[]): Array<AbstractCanvasObject<any>>;
-    private calculateImageCaptureCoefficient;
-    private randomId;
-    private getLowestTextPoint;
-    private trackNewObject;
-    private dimensionsExceedRestrictions;
-}
-export declare class SelectionData implements ISelectionData {
-    readonly empty: boolean;
-    readonly objects: Array<AbstractCanvasObject<any>>;
-    readonly isText: boolean;
-    readonly textSelection: ITextSelection | null;
-    event: IEvent<MouseEvent>;
-    constructor(objects: Array<AbstractCanvasObject<any>>);
-    setEvent(event: IEvent<MouseEvent>): void;
-}
+import { BehaviorSubject, Observable, Subject } from "rxjs";
+import { ICutoff } from "./object/impl/cutoff";
+import { IRectangle } from "./object/impl/rectangle";
+import { IBorder } from "./object/impl/border";
+import { IImage } from "./object/impl/image";
+import { IText } from "./object/impl/text";
+import { ILayoutManager } from "./layout/layout-manager.interface";
+import { LayoutManager } from "./layout/layout-manager.enum";
+import { IVerticalRule } from "./object/impl/vertical-rule";
+import { IHorizontalRule } from "./object/impl/horizontal-rule";
+import { IInteractiveCanvas } from "./interactive-canvas.interface";
+import { ICanvasProfile } from "./profile/canvas-profile.interface";
+import { IFontLibrary } from "./font/font-library.interface";
+import { ICanvasDimensions } from "./types/canvas-dimensions.interface";
+import { ICanvasDimensionRestrictions } from "./types/canvas-dimension-restrictions.interface";
+import { AbstractCanvasObject } from "./object/abstract-canvas-object";
+import { IRect } from "./types/rect.interface";
+import { ObjectType } from "./types/object-type.enum";
+import { ICanvasObject } from "./object/canvas-object.interface";
+import { ISelectionData } from "./types/selection-data.interface";
+import { ICanvasState } from "./types/canvas-state.interface";
+import { ITextSelection } from "./mutator/mutable-text-style.interface";
+import { fabric } from "fabric";
+import { IRichText } from "./object/impl/rich-text";
+import { IBackgroundImage } from "./object/impl/background-image";
+import { IEvent } from "fabric/fabric-impl";
+export declare abstract class AbstractInteractiveCanvas implements IInteractiveCanvas {
+    fabric: any;
+    protected readonly fabricCanvas: fabric.Canvas;
+    protected devicePixelRatio: number;
+    protected readonly IMAGE_CAPTURE_COEFFICIENT: number;
+    abstract readonly headless: boolean;
+    protected readonly fontLibrary: IFontLibrary;
+    protected readonly profile$: BehaviorSubject<ICanvasProfile>;
+    protected readonly layoutManager$: BehaviorSubject<ILayoutManager>;
+    protected readonly backgroundColor$: BehaviorSubject<string>;
+    protected readonly dimensions$: BehaviorSubject<ICanvasDimensions>;
+    protected readonly dimensionRestrictions$: BehaviorSubject<ICanvasDimensionRestrictions>;
+    protected readonly dimensionChangeRejections$: Subject<ICanvasDimensions>;
+    protected readonly zoom$: BehaviorSubject<number>;
+    protected readonly objects$: BehaviorSubject<Array<AbstractCanvasObject<any>>>;
+    protected readonly selection$: BehaviorSubject<SelectionData>;
+    protected baseDimensions: ICanvasDimensions;
+    protected constructor(fabric: any, fabricCanvas: fabric.Canvas, devicePixelRatio: number);
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getFontLibrary(): IFontLibrary;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getProfile(): ICanvasProfile;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getProfile$(): Observable<ICanvasProfile>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setProfile(profile: ICanvasProfile): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getLayoutManager(): ILayoutManager;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getLayoutManager$(): Observable<ILayoutManager>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setLayoutManager(layoutManager: LayoutManager): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getBackgroundColor(): string;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getBackgroundColor$(): Observable<string>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setBackgroundColor(color?: string): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getDimensions(): ICanvasDimensions;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getBaseDimensions(): ICanvasDimensions;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getDimensions$(): Observable<ICanvasDimensions>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setDimensions(dimensions: ICanvasDimensions): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setBaseDimensions(dimensions: ICanvasDimensions): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getDimensionChangeRejections$(): Observable<ICanvasDimensions>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getDimensionsRestrictions(): ICanvasDimensionRestrictions;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getDimensionsRestrictions$(): Observable<ICanvasDimensionRestrictions>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setDimensionRestrictions(restrictions: ICanvasDimensionRestrictions): void;
+    getMargin(): IRect;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getZoom(): number;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getZoom$(): Observable<number>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setZoom(zoom: number): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getObjects(): ICanvasObject[];
+    /**
+     * Get the list of objects directly.
+     */
+    getObjectsInternal(): Array<AbstractCanvasObject<any>>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getObjectsByTypeInternal<T extends AbstractCanvasObject<any>>(type: ObjectType): T[];
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getObjectsByTypesInternal(...types: ObjectType[]): Array<AbstractCanvasObject<any>>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getObjects$(): Observable<ICanvasObject[]>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    removeObject(target: ICanvasObject): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    addImageObject(imageUrl: string): Promise<IImage>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    addTextObject(): Promise<IText>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    addRichTextObject(imageUrl: string, htmlContent: string): Promise<IRichText>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    addRectangleObject(): Promise<IRectangle>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    addCutoffObject(): Promise<ICutoff>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    addBorderObject(): Promise<IBorder>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    addVerticalRuleObject(): Promise<IVerticalRule>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    addHorizontalRuleObject(): Promise<IHorizontalRule>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    addBackgroundImageObject(imageUrl: string): Promise<IBackgroundImage>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setPrefillData(data: {
+        [id: string]: string;
+    }): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    distributeObjectsVertically(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getSelection(): ISelectionData;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getSelection$(): Observable<ISelectionData>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    select(object: ICanvasObject): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    clearSelection(): void;
+    setMultiSelect(value: boolean): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    clear(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    save(): ICanvasState;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    load(canvasState: ICanvasState): Promise<void>;
+    /**
+     * Another hack for bullet points... because they use canvas objects to render the bullets, they get saved when the canvas is persisted... and then loaded into a new canvas, but there's
+     * nothing linking them to the field that needs bullets, so they end up duplicating every time the canvas is saved/loaded. Since we don't use circles for anything else, this just
+     * deletes all circles on canvas load.
+     */
+    private removePersistedBullets;
+    /**
+     * Remove any slave objects persisted to the canvas; their master objects will recreate them.
+     */
+    private removeSlaveObjects;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    toSvg(): string;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    toImage(multiplier?: number): string;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    createPNGStream(): any;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    registerUndoState(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    undo(): Promise<void>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    redo(): Promise<void>;
+    /**
+     * Redraw the canvas.
+     */
+    redraw(): void;
+    syncObjectList(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    notifyObjectListChanged(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    notifyTextChanged(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    notifyMarginChanged(): void;
+    removeFabricObject(obj: any): void;
+    protected selectFabricObject(object: fabric.Object): void;
+    protected onTextChange(): void;
+    protected onObjectListChange(): void;
+    protected onDimensionsChange(): void;
+    protected onMarginChange(): void;
+    private bindFields;
+    private bindField;
+    private findFabricObject;
+    private findObject;
+    /**
+     * Reset zoom and canvas dimensions to 1:1 scale, execute a function, then return the canvas to
+     * the previous values.
+     * @param func Function to execute.
+     */
+    private executeWithNormalizedCanvas;
+    /**
+     * Update the actual dimensions of the canvas by multiplying the requested dimensions by the current zoom factor.
+     */
+    private updateCanvasDimensions;
+    protected onProfileChanged(profile: ICanvasProfile): void;
+    protected getFieldByCanvasObject?(object: any): AbstractCanvasObject<any> | null;
+    protected getFieldsByCanvasObject(objects: any[]): Array<AbstractCanvasObject<any>>;
+    private calculateImageCaptureCoefficient;
+    private randomId;
+    private getLowestTextPoint;
+    private trackNewObject;
+    private dimensionsExceedRestrictions;
+}
+export declare class SelectionData implements ISelectionData {
+    readonly empty: boolean;
+    readonly objects: Array<AbstractCanvasObject<any>>;
+    readonly isText: boolean;
+    readonly textSelection: ITextSelection | null;
+    event: IEvent<MouseEvent>;
+    constructor(objects: Array<AbstractCanvasObject<any>>);
+    setEvent(event: IEvent<MouseEvent>): void;
+}