@leapfrog/interactive-canvas 1.0.0 → 1.0.2

package/dist/layout/abstract-layout-manager.d.ts

@@ -1,17 +0,0 @@
-import { ILayoutManager } from "./layout-manager.interface";
-import { LayoutManager } from "./layout-manager.enum";
-import { ICanvasProfile, IInteractiveCanvas } from "..";
-export declare abstract class AbstractLayoutManager implements ILayoutManager {
-    abstract readonly key: LayoutManager;
-    readonly isEnforcedPositioning: boolean;
-    readonly enterTextEditImmediatelyOnSelect: boolean;
-    protected canvas: IInteractiveCanvas;
-    protected constructor(canvas: IInteractiveCanvas);
-    getCanvas(): IInteractiveCanvas;
-    onInit(): void;
-    onProfileChange(profile: ICanvasProfile): void;
-    onCanvasDimensionsChange(): void;
-    onTextChange(): void;
-    onObjectListChange(): void;
-    onMarginChange(): void;
-}

package/dist/layout/advanced-layout-manager.d.ts

@@ -1,15 +0,0 @@
-import { AbstractLayoutManager } from "./abstract-layout-manager";
-import { LayoutManager } from "./layout-manager.enum";
-import { IInteractiveCanvas } from "../interactive-canvas.interface";
-export declare class AdvancedLayoutManager extends AbstractLayoutManager {
-    readonly key: LayoutManager;
-    private pinToBottom;
-    private redrawAll;
-    private repositionBorders;
-    private repositionCutoffs;
-    private resizeCanvas;
-    constructor(canvas: IInteractiveCanvas);
-    onCanvasDimensionsChange(): void;
-    onTextChange(): void;
-    onObjectListChange(): void;
-}

package/dist/layout/function/pin-to-bottom.layout-function.d.ts

@@ -1,4 +0,0 @@
-import { IInteractiveCanvas } from "../../interactive-canvas.interface";
-export declare class PinToBottomLayoutFunction {
-    execute(canvas: IInteractiveCanvas): void;
-}

package/dist/layout/function/redraw-all.layout-function.d.ts

@@ -1,4 +0,0 @@
-import { IInteractiveCanvas } from "../../interactive-canvas.interface";
-export declare class RedrawAllLayoutFunction {
-    execute(canvas: IInteractiveCanvas): void;
-}

package/dist/layout/function/reposition-borders.layout-function.d.ts

@@ -1,4 +0,0 @@
-import { IInteractiveCanvas } from "../..";
-export declare class RepositionBordersLayoutFunction {
-    execute(canvas: IInteractiveCanvas): void;
-}

package/dist/layout/function/reposition-cutoffs.layout-function.d.ts

@@ -1,4 +0,0 @@
-import { IInteractiveCanvas } from "../..";
-export declare class RepositionCutoffsLayoutFunction {
-    execute(canvas: IInteractiveCanvas): void;
-}

package/dist/layout/function/resize-canvas.layout-function.d.ts

@@ -1,4 +0,0 @@
-import { IInteractiveCanvas } from "../..";
-export declare class ResizeCanvasLayoutFunction {
-    execute(canvas: IInteractiveCanvas): void;
-}

package/dist/layout/function/stack-objects.layout-function.d.ts

@@ -1,11 +0,0 @@
-import { IInteractiveCanvas } from "../../interactive-canvas.interface";
-export declare class StackObjectsLayoutFunction {
-    execute(canvas: IInteractiveCanvas): void;
-    private layoutFooter;
-    private layoutBody;
-    private applyWidths;
-    private adjustCanvasSize;
-    private getRows;
-    private getObjectHeight;
-    private countSpaces;
-}

package/dist/layout/function/update-object-dimensions.layout-function.d.ts

@@ -1,4 +0,0 @@
-import { IInteractiveCanvas } from "../../interactive-canvas.interface";
-export declare class UpdateObjectDimensionsLayoutFunction {
-    execute(canvas: IInteractiveCanvas): void;
-}

package/dist/layout/layout-manager.enum.d.ts

@@ -1,5 +0,0 @@
-export declare enum LayoutManager {
-    LEGACY = "LEGACY",
-    STANDARD = "STANDARD",
-    ADVANCED = "ADVANCED"
-}

package/dist/layout/layout-manager.interface.d.ts

@@ -1,13 +0,0 @@
-import { LayoutManager } from "./layout-manager.enum";
-import { ICanvasProfile } from "..";
-export interface ILayoutManager {
-    readonly key: LayoutManager;
-    readonly isEnforcedPositioning: boolean;
-    readonly enterTextEditImmediatelyOnSelect: boolean;
-    onInit(): void;
-    onProfileChange(profile: ICanvasProfile): void;
-    onCanvasDimensionsChange(): void;
-    onTextChange(): void;
-    onObjectListChange(): void;
-    onMarginChange(): void;
-}

package/dist/layout/standard-layout-manager.d.ts

@@ -1,35 +0,0 @@
-import { AbstractLayoutManager } from "./abstract-layout-manager";
-import { LayoutManager } from "./layout-manager.enum";
-import { ICanvasProfile, IInteractiveCanvas } from "..";
-export declare class StandardLayoutManager extends AbstractLayoutManager {
-    readonly key: LayoutManager;
-    readonly isEnforcedPositioning: boolean;
-    readonly enterTextEditImmediatelyOnSelect: boolean;
-    private redrawAll;
-    private repositionCutoffs;
-    private repositionBorders;
-    private stackObjects;
-    private updateObjectDimensions;
-    constructor(canvas: IInteractiveCanvas);
-    /**
-     * @override
-     */
-    onInit(): void;
-    /**
-     * @override
-     */
-    onProfileChange(profile: ICanvasProfile): void;
-    /**
-     * @override
-     */
-    onTextChange(): void;
-    /**
-     * @override
-     */
-    onObjectListChange(): void;
-    /**
-     * @override
-     */
-    onMarginChange(): void;
-    private stackAndRedraw;
-}

package/dist/mutator/mutable-background-color.interface.d.ts

@@ -1,15 +0,0 @@
-/**
- * Canvas object with customizable background color.
- */
-export interface IMutableBackgroundColor {
-    /**
-     * Get the background color.
-     */
-    getBackgroundColor(): string;
-    /**
-     * Set the background color.
-     * @param color Color.
-     */
-    setBackgroundColor(color: string): void;
-}
-export declare function isMutableBackgroundColor(object: any): object is IMutableBackgroundColor;

package/dist/mutator/mutable-color.interface.d.ts

@@ -1,6 +0,0 @@
-import { ICanvasObject } from "..";
-export interface IMutableColor extends ICanvasObject {
-    getColor(): string;
-    setColor(color: string): void;
-}
-export declare function isMutableColor(object: any): object is IMutableColor;

package/dist/mutator/mutable-image.interface.d.ts

@@ -1,28 +0,0 @@
-import { Observable } from "rxjs";
-import { ICanvasObject, IDimensionRestrictions } from "..";
-/**
- * Canvas field with a modifiable image.
- */
-export interface IMutableImage extends ICanvasObject {
-    /**
-     * Get the image url.
-     */
-    getImageUrl(): string;
-    /**
-     * Get an observable of the image url.
-     */
-    getImageUrl$(): Observable<string>;
-    /**
-     * Set the image url.
-     * @param url New url.
-     */
-    setImageUrl(url: string): void;
-    /**
-     * Sets the image width to x pixels.
-     * @param px Pixels.
-     * @param sizeRestrictions Restrictions on image size.
-     * @returns the new width in pixels
-     */
-    setImageWidth(px: number, sizeRestrictions: IDimensionRestrictions): number;
-}
-export declare function isMutableImage(object: any): object is IMutableImage;

package/dist/mutator/mutable-position.interface.d.ts

@@ -1,33 +0,0 @@
-import { ICanvasObject } from "..";
-export interface IMutablePosition extends ICanvasObject {
-    /**
-     * Center the object horizontally on the canvas.
-     */
-    centerHorizontally(): void;
-    /**
-     * Center the object vertically on the canvas.
-     */
-    centerVertically(): void;
-    /**
-     * Set the height of the element.
-     * @param height New height.
-     */
-    setHeight(height: number): void;
-    /**
-     * Nudge the object upward.
-     */
-    nudgeUp(): void;
-    /**
-     * Nudge the object downward.
-     */
-    nudgeDown(): void;
-    /**
-     * Nudge the object leftward.
-     */
-    nudgeLeft(): void;
-    /**
-     * Nudge the object rightward.
-     */
-    nudgeRight(): void;
-}
-export declare function isMutablePosition(object: any): object is IMutablePosition;

package/dist/mutator/mutable-text-style.interface.d.ts

@@ -1,163 +0,0 @@
-import { Observable } from "rxjs";
-import { IFont, TextAlignment } from "..";
-import { IMutableText } from "./mutable-text.interface";
-/**
- * Canvas object with customizable text styling
- */
-export interface IMutableTextStyle extends IMutableText {
-    /**
-     * Get the current text selection.
-     */
-    getTextSelection(): ITextSelection;
-    /**
-     * Get an observable for the current {@link #getTextSelection text selection}.
-     */
-    getTextSelection$(): Observable<ITextSelection>;
-    /**
-     * Set the text alignment.
-     * @param alignment New value.
-     */
-    setTextAlign(alignment: TextAlignment): void;
-    /**
-     * Set the character spacing.
-     * @param spacing New value.
-     */
-    setCharSpacing(spacing: number): void;
-    /**
-     * Set the line height.
-     * @param height New value.
-     */
-    setLineHeight(height: number): void;
-    /**
-     * Set the bold state of the current selection.
-     * @param bold Bold state.
-     */
-    setBold(bold?: boolean): void;
-    /**
-     * Set a specified region to bold.
-     * @param start region start index.
-     * @param end region end index.
-     * @param bold whether to set bold or not.
-     */
-    setBoldRegion(start: number, end: number, bold?: boolean): void;
-    /**
-     * Set the italic state of the current selection.
-     * @param italic Italic state.
-     */
-    setItalic(italic?: boolean): void;
-    /**
-     * Set a specified region to italic.
-     * @param start region start index.
-     * @param end region end index.
-     * @param italic whether to set italic or not.
-     */
-    setItalicRegion(start: number, end: number, italic?: boolean): void;
-    /**
-     * Set the strikethrough state of the current selection.
-     * @param strikethrough Strikethrough state.
-     */
-    setStrikethrough(strikethrough?: boolean): void;
-    /**
-     * Set the underline state of the current selection.
-     * @param underline Underline state.
-     */
-    setUnderline(underline?: boolean): void;
-    /**
-     * Set the font.
-     * @param font New value.
-     */
-    setFont(font: IFont): void;
-    /**
-     * Set the font size.
-     * @param fontSize New value.
-     */
-    setFontSize(fontSize: number): void;
-    /**
-     * Set the text background color.
-     * @param color New value.
-     */
-    setTextBackgroundColor(color: string): void;
-}
-export interface ITextSelection {
-    /**
-     * Index of selection start in characters.
-     */
-    readonly start: number;
-    /**
-     * Index of selection end in characters.
-     */
-    readonly end: number;
-    /**
-     * Selection length in characters.
-     */
-    readonly length: number;
-    /**
-     * Selection start line index.
-     */
-    readonly lineIndex: number;
-    /**
-     * Selection start character index (from start of current line).
-     */
-    readonly charIndex: number;
-    /**
-     * Current font.
-     */
-    readonly font: IFont;
-    /**
-     * Font size.
-     */
-    readonly fontSize: number;
-    /**
-     * Font weight.
-     */
-    readonly fontWeight: number;
-    /**
-     * Current text alignment.
-     */
-    readonly textAlign: TextAlignment;
-    /**
-     * Current character spacing.
-     */
-    readonly charSpacing: number;
-    /**
-     * Current line height.
-     */
-    readonly lineHeight: number;
-    /**
-     * True if the current selection is bold.
-     */
-    readonly bold: boolean;
-    /**
-     * True if the current selection is italic.
-     */
-    readonly italic: boolean;
-    /**
-     * Whether the text has an underline.
-     */
-    readonly underline: boolean;
-    /**
-     * Whether the text has a strikethrough.
-     */
-    readonly strikethrough: boolean;
-    /**
-     * Whether the text has an overline.
-     */
-    readonly overline: boolean;
-    /**
-     * Fill color.
-     */
-    readonly fill: string;
-    /**
-     * Stroke color.
-     */
-    readonly stroke: string;
-    /**
-     * Stroke width.
-     */
-    readonly strokeWidth: number;
-    /**
-     * Background color.
-     */
-    readonly textBackgroundColor: string;
-}
-export declare function isMutableTextStyle(object: any): object is IMutableText;

package/dist/mutator/mutable-text.interface.d.ts

@@ -1,40 +0,0 @@
-import { Observable } from "rxjs";
-import { ICanvasObject } from "..";
-/**
- * Because of the way styles are handled in fabric, stored as a separate list of character pointers and not inline as per HTML, modifying the text directly is dangerous - it will cause the
- * location of the styles to become out of sync with the actual text if the length changes.
- * Text modification should be performed by inserting the selection cursor at a given position and modifying the selection... this lets the canvas track changes and update the styles accordingly.
- * It's pretty crap, honestly but text support is explicitly a second-class citizen in fabric, as the author has stated text support is out-of-scope for the library:
- * https://github.com/fabricjs/fabric.js/issues/3443#issuecomment-262263542
- */
-export interface IMutableText extends ICanvasObject {
-    getText(): string;
-    getText$(): Observable<string>;
-    /**
-     * Generally, don't use this. It will not modify the style locations, and if the text length changes, it will cause the
-     * styles to slide out of place.
-     * Use {@link IMutableText#replaceText} instead, where feasible.
-     * @param text New text.
-     * @see {@link IMutableText#replaceText}
-     */
-    setText(text: string): void;
-    /**
-     * Replace a text fragment in the field. Honors existing styling as much as possible.
-     * @param target Existing text fragment.
-     * @param replacement Replacement fragment.
-     */
-    replaceText(target: string, replacement: string): void;
-    /**
-     * Is the text bulleted?
-     */
-    isBulleted(): boolean;
-    /**
-     * Enable bullet points.
-     */
-    enableBullets(): void;
-    /**
-     * Disable bullet points.
-     */
-    disableBullets(): void;
-}
-export declare function isMutableText(object: any): object is IMutableText;

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

@@ -1,155 +0,0 @@
-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 +0,0 @@
-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);
-}