@leapfrog/interactive-canvas 0.1.0 → 1.0.0

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

@@ -1,155 +1,155 @@
-import { Observable } from "rxjs";
-import { ICanvasProfile, ILayoutManager, IMargin, IObjectDimensions, IOverflow, IPosition, ObjectType } from "..";
-import { InteractiveCanvas } from "../interactive-canvas.impl";
-import { ICanvasObject } from "./canvas-object.interface";
-import { CanvasObjectData } from "./canvas-object-data";
-import { Object } from "fabric/fabric-impl";
-export declare abstract class AbstractCanvasObject<T extends Object> implements ICanvasObject {
-    protected pinToBottomDistance: number;
-    protected canvas: InteractiveCanvas;
-    protected fabricObject: T;
-    protected data: CanvasObjectData;
-    private readonly dimensions$;
-    /**
-     * Create a new instance.
-     * @param type Object type.
-     * @param canvas Interactive canvas that the field will be rendered on.
-     * @param fabricObject The fabric object to bind this field to.
-     * @param data Existing persisted field data to load from, if applicable.
-     */
-    protected constructor(type: ObjectType, canvas: InteractiveCanvas, fabricObject: any, data?: CanvasObjectData);
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getId(): string;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getType(): ObjectType;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getDescription(): string;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setSortCaption(value: boolean): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    isSortCaption(): boolean;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getDimensions(): IObjectDimensions;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getDimensions$(): Observable<IObjectDimensions>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getMargin(): IMargin;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setMargin(margin: IMargin): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getColumnWidthPercent(): number;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setColumnWidthPercent(percent: number): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    bringForward(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    bringToFront(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    sendBackward(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    sendToBack(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    moveUp(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    moveDown(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    delete(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    persist(): CanvasObjectData;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    isPinToBottom(): boolean;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setPinToBottom(value?: boolean): void;
-    /**
-     * Get the underlying fabric object.
-     * (Internal use only, do not expose this outside the canvas module).
-     */
-    getFabricObjectInternal(): T;
-    setPosition(position: IPosition): void;
-    setCoords(): void;
-    updateDimensions(): void;
-    getBoundingBox(): {
-        top: number;
-        left: number;
-        width: number;
-        height: number;
-    };
-    moveToPinnedPosition(): void;
-    protected updatePinToBottomDistance(): void;
-    protected redraw(): void;
-    protected onProfileChange(profile: ICanvasProfile): void;
-    protected onLayoutManagerChange(layoutManager: ILayoutManager): void;
-    protected onMove(event: any): void;
-    protected onRotate(event: any): void;
-    protected onScale(event: any): void;
-    protected onDelete(): void;
-    protected preventLeavingCanvas(): void;
-    protected getCanvasOverflow(): IOverflow;
-    protected centerHorizontallyInternal(): void;
-    protected centerVerticallyInternal(): void;
-    protected nudgeInternal(x?: number, y?: number): void;
-    protected updateFabricObjectBehavior(): void;
-}
+import { Observable } from "rxjs";
+import { ICanvasProfile, ILayoutManager, IMargin, IObjectDimensions, IOverflow, IPosition, ObjectType } from "..";
+import { ICanvasObject } from "./canvas-object.interface";
+import { CanvasObjectData } from "./canvas-object-data";
+import { IInteractiveCanvas } from "../interactive-canvas.interface";
+import { Object } from "fabric/fabric-impl";
+export declare abstract class AbstractCanvasObject<T extends Object> implements ICanvasObject {
+    protected pinToBottomDistance: number;
+    protected canvas: IInteractiveCanvas;
+    protected fabricObject: T;
+    protected data: CanvasObjectData;
+    private readonly dimensions$;
+    /**
+     * Create a new instance.
+     * @param type Object type.
+     * @param canvas Interactive canvas that the field will be rendered on.
+     * @param fabricObject The fabric object to bind this field to.
+     * @param data Existing persisted field data to load from, if applicable.
+     */
+    protected constructor(type: ObjectType, canvas: IInteractiveCanvas, fabricObject: any, data?: CanvasObjectData);
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getId(): string;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getType(): ObjectType;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getDescription(): string;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setSortCaption(value: boolean): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    isSortCaption(): boolean;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getDimensions(): IObjectDimensions;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getDimensions$(): Observable<IObjectDimensions>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getMargin(): IMargin;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setMargin(margin: IMargin): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getColumnWidthPercent(): number;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setColumnWidthPercent(percent: number): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    bringForward(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    bringToFront(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    sendBackward(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    sendToBack(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    moveUp(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    moveDown(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    delete(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    persist(): CanvasObjectData;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    isPinToBottom(): boolean;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setPinToBottom(value?: boolean): void;
+    /**
+     * Get the underlying fabric object.
+     * (Internal use only, do not expose this outside the canvas module).
+     */
+    getFabricObjectInternal(): T;
+    setPosition(position: IPosition): void;
+    setCoords(): void;
+    updateDimensions(): void;
+    getBoundingBox(): {
+        top: number;
+        left: number;
+        width: number;
+        height: number;
+    };
+    moveToPinnedPosition(): void;
+    protected updatePinToBottomDistance(): void;
+    protected redraw(): void;
+    protected onProfileChange(profile: ICanvasProfile): void;
+    protected onLayoutManagerChange(layoutManager: ILayoutManager): void;
+    protected onMove(event: any): void;
+    protected onRotate(event: any): void;
+    protected onScale(event: any): void;
+    protected onDelete(): void;
+    protected preventLeavingCanvas(): void;
+    protected getCanvasOverflow(): IOverflow;
+    protected centerHorizontallyInternal(): void;
+    protected centerVerticallyInternal(): void;
+    protected nudgeInternal(x?: number, y?: number): void;
+    protected updateFabricObjectBehavior(): void;
+}

package/dist/object/canvas-object-data.d.ts

@@ -1,23 +1,23 @@
-import { IMargin, ObjectType } from "..";
-/**
- * Data for a persisted canvas object.
- */
-export declare class CanvasObjectData {
-    type: ObjectType;
-    id: string;
-    fieldName?: string;
-    pinToBottom?: boolean;
-    margin?: IMargin;
-    columnWidthPercent?: number;
-    color?: string;
-    strokeWidth?: number;
-    editable?: boolean;
-    prefillType: string;
-    sortCaption?: boolean;
-    resizeCanvas: boolean;
-    placeholder?: string;
-    userText?: string;
-    bulleted?: boolean;
-    imagePath?: string;
-    constructor(type: ObjectType, id: string);
-}
+import { IMargin, ObjectType } from "..";
+/**
+ * Data for a persisted canvas object.
+ */
+export declare class CanvasObjectData {
+    type: ObjectType;
+    id: string;
+    fieldName?: string;
+    pinToBottom?: boolean;
+    margin?: IMargin;
+    columnWidthPercent?: number;
+    color?: string;
+    strokeWidth?: number;
+    editable?: boolean;
+    prefillType: string;
+    sortCaption?: boolean;
+    resizeCanvas: boolean;
+    placeholder?: string;
+    userText?: string;
+    bulleted?: boolean;
+    imagePath?: string;
+    constructor(type: ObjectType, id: string);
+}

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

@@ -1,96 +1,96 @@
-import { Observable } from "rxjs";
-import { IMargin, IObjectDimensions, ObjectType } from "..";
-import { CanvasObjectData } from "./canvas-object-data";
-/**
- * An object rendered on the {@link IInteractiveCanvas Interactive Canvas}.
- */
-export interface ICanvasObject {
-    /**
-     * Get the field id.
-     */
-    getId(): string;
-    /**
-     * Get the field type.
-     */
-    getType(): ObjectType;
-    /**
-     * Get the field description, a user-friendly version of Type.
-     */
-    getDescription(): string;
-    /**
-     * Set whether this field is to be used for the sort caption.
-     */
-    setSortCaption(value: boolean): void;
-    /**
-     * True if this field is a sort caption.
-     */
-    isSortCaption(): boolean;
-    /**
-     * Get object dimensions.
-     * @see IObjectDimensions.
-     */
-    getDimensions(): IObjectDimensions;
-    /**
-     * Get an observable for the field dimensions.
-     */
-    getDimensions$(): Observable<IObjectDimensions>;
-    /**
-     * Get the component margin.
-     */
-    getMargin(): IMargin;
-    /**
-     * Set component margin.
-     * @param margin New margin.
-     */
-    setMargin(margin: IMargin): void;
-    /**
-     * Get the column width percentage.
-     */
-    getColumnWidthPercent(): number;
-    /**
-     * Set column width percentage.
-     * @param percent New value.
-     */
-    setColumnWidthPercent(percent: number): void;
-    /**
-     * Bring object to front.
-     */
-    bringToFront(): void;
-    /**
-     * Bring object forward one place.
-     */
-    bringForward(): void;
-    /**
-     * Send object backward one place.
-     */
-    sendBackward(): void;
-    /**
-     * Send object to the back.
-     */
-    sendToBack(): void;
-    /**
-     * Move the object up in the object list.
-     */
-    moveUp(): void;
-    /**
-     * Move the object down in the object list.
-     */
-    moveDown(): void;
-    /**
-     * Delete this object, removing it from the canvas.
-     */
-    delete(): void;
-    /**
-     * Persist this object, returning a copy of the data block.
-     */
-    persist(): CanvasObjectData;
-    /**
-     * Get whether the object is pinned to the bottom of the canvas.
-     */
-    isPinToBottom(): boolean;
-    /**
-     * Set whether the object is pinned to the bottom of the canvas.
-     * @param value New value.
-     */
-    setPinToBottom(value?: boolean): void;
-}
+import { Observable } from "rxjs";
+import { IMargin, IObjectDimensions, ObjectType } from "..";
+import { CanvasObjectData } from "./canvas-object-data";
+/**
+ * An object rendered on the {@link IInteractiveCanvas Interactive Canvas}.
+ */
+export interface ICanvasObject {
+    /**
+     * Get the field id.
+     */
+    getId(): string;
+    /**
+     * Get the field type.
+     */
+    getType(): ObjectType;
+    /**
+     * Get the field description, a user-friendly version of Type.
+     */
+    getDescription(): string;
+    /**
+     * Set whether this field is to be used for the sort caption.
+     */
+    setSortCaption(value: boolean): void;
+    /**
+     * True if this field is a sort caption.
+     */
+    isSortCaption(): boolean;
+    /**
+     * Get object dimensions.
+     * @see IObjectDimensions.
+     */
+    getDimensions(): IObjectDimensions;
+    /**
+     * Get an observable for the field dimensions.
+     */
+    getDimensions$(): Observable<IObjectDimensions>;
+    /**
+     * Get the component margin.
+     */
+    getMargin(): IMargin;
+    /**
+     * Set component margin.
+     * @param margin New margin.
+     */
+    setMargin(margin: IMargin): void;
+    /**
+     * Get the column width percentage.
+     */
+    getColumnWidthPercent(): number;
+    /**
+     * Set column width percentage.
+     * @param percent New value.
+     */
+    setColumnWidthPercent(percent: number): void;
+    /**
+     * Bring object to front.
+     */
+    bringToFront(): void;
+    /**
+     * Bring object forward one place.
+     */
+    bringForward(): void;
+    /**
+     * Send object backward one place.
+     */
+    sendBackward(): void;
+    /**
+     * Send object to the back.
+     */
+    sendToBack(): void;
+    /**
+     * Move the object up in the object list.
+     */
+    moveUp(): void;
+    /**
+     * Move the object down in the object list.
+     */
+    moveDown(): void;
+    /**
+     * Delete this object, removing it from the canvas.
+     */
+    delete(): void;
+    /**
+     * Persist this object, returning a copy of the data block.
+     */
+    persist(): CanvasObjectData;
+    /**
+     * Get whether the object is pinned to the bottom of the canvas.
+     */
+    isPinToBottom(): boolean;
+    /**
+     * Set whether the object is pinned to the bottom of the canvas.
+     * @param value New value.
+     */
+    setPinToBottom(value?: boolean): void;
+}

package/dist/object/impl/border.d.ts

@@ -1,60 +1,59 @@
-import { Observable } from "rxjs";
-import { ICanvasObject } from "../canvas-object.interface";
-import { IMutableColor } from "../..";
-import { AbstractCanvasObject } from "../abstract-canvas-object";
-import { InteractiveCanvas } from "../../interactive-canvas.impl";
-import { CanvasObjectData } from "../canvas-object-data";
-import { fabric } from "fabric";
-/**
- * Border field. A rectangle with a stroke width that automatically follows the canvas border.
- */
-export interface IBorder extends ICanvasObject, IMutableColor {
-    /**
-     * Get the width of the border stroke.
-     */
-    getStrokeWidth(): number;
-    /**
-     * Get an observable of the width of the cutoff stroke.
-     */
-    getStrokeWidth$(): Observable<number>;
-    /**
-     * Set the border stroke width.
-     * @param width New width.
-     */
-    setStrokeWidth(width: number): void;
-}
-export declare class Border extends AbstractCanvasObject<fabric.Rect> implements IBorder {
-    private readonly strokeWidth$;
-    constructor(canvas: InteractiveCanvas, fabricObject: fabric.Rect, persistedField?: CanvasObjectData);
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getColor(): string;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setColor(color: string): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getStrokeWidth(): number;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    getStrokeWidth$(): Observable<number>;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    setStrokeWidth(width: number): void;
-    updatePosition(): void;
-    /**
-     * @override
-     * @inheritDoc
-     */
-    protected updateFabricObjectBehavior(): void;
-}
+import { Observable } from "rxjs";
+import { ICanvasObject } from "../canvas-object.interface";
+import { IInteractiveCanvas, IMutableColor } from "../..";
+import { AbstractCanvasObject } from "../abstract-canvas-object";
+import { CanvasObjectData } from "../canvas-object-data";
+import { fabric } from "fabric";
+/**
+ * Border field. A rectangle with a stroke width that automatically follows the canvas border.
+ */
+export interface IBorder extends ICanvasObject, IMutableColor {
+    /**
+     * Get the width of the border stroke.
+     */
+    getStrokeWidth(): number;
+    /**
+     * Get an observable of the width of the cutoff stroke.
+     */
+    getStrokeWidth$(): Observable<number>;
+    /**
+     * Set the border stroke width.
+     * @param width New width.
+     */
+    setStrokeWidth(width: number): void;
+}
+export declare class Border extends AbstractCanvasObject<fabric.Rect> implements IBorder {
+    private readonly strokeWidth$;
+    constructor(canvas: IInteractiveCanvas, fabricObject: fabric.Rect, persistedField?: CanvasObjectData);
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getColor(): string;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setColor(color: string): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getStrokeWidth(): number;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    getStrokeWidth$(): Observable<number>;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    setStrokeWidth(width: number): void;
+    updatePosition(): void;
+    /**
+     * @override
+     * @inheritDoc
+     */
+    protected updateFabricObjectBehavior(): void;
+}