react-design-editor 0.0.31 → 0.0.35

package/lib/utils/ObjectUtil.d.ts

@@ -1,412 +1,407 @@
-/// <reference types="animejs" />
-import { fabric } from 'fabric';
-import { IFilter } from '../handlers/ImageHandler';
-export declare type AnimationType = 'fade' | 'bounce' | 'shake' | 'scaling' | 'rotation' | 'flash' | 'none';
-export interface AnimationProperty {
-    delay?: number;
-    duration?: number;
-    autoplay?: boolean;
-    loop?: boolean | number;
-    type: AnimationType;
-    offset?: number;
-    opacity?: number;
-    bounce?: 'vertical' | 'horizontal';
-    shake?: 'vertical' | 'horizontal';
-    scale?: number;
-    angle?: number;
-    fill?: string | fabric.Pattern;
-    stroke?: string;
-}
-export interface LinkProperty {
-    enabled?: boolean;
-    type?: string;
-    state?: string;
-    dashboard?: any;
-}
-export interface TooltipProperty {
-    enabled?: boolean;
-    type?: string;
-    template?: string;
-}
-export interface TriggerProperty {
-    enabled?: boolean;
-    type?: string;
-    script?: string;
-    effect?: string;
-}
-export interface FabricCanvasOption {
-    wrapperEl?: HTMLElement;
-}
-export declare type FabricCanvas<T extends any = fabric.Canvas> = T & FabricCanvasOption;
-export declare type FabricObjectOption<T extends any = fabric.IObjectOptions> = T & {
-    /**
-     * Object id
-     * @type {string}
-     */
-    id?: string;
-    /**
-     * Parent object id
-     * @type {string}
-     */
-    parentId?: string;
-    /**
-     * Original opacity
-     * @type {number}
-     */
-    originOpacity?: number;
-    /**
-     * Original top position
-     * @type {number}
-     */
-    originTop?: number;
-    /**
-     * Original left position
-     * @type {number}
-     */
-    originLeft?: number;
-    /**
-     * Original scale X
-     * @type {number}
-     */
-    originScaleX?: number;
-    /**
-     * Original scale Y
-     * @type {number}
-     */
-    originScaleY?: number;
-    /**
-     * Original angle
-     * @type {number}
-     */
-    originAngle?: number;
-    /**
-     * Original fill color
-     * @type {(string | fabric.Pattern)}
-     */
-    originFill?: string | fabric.Pattern;
-    /**
-     * Original stroke color
-     * @type {string}
-     */
-    originStroke?: string;
-    /**
-     * Object editable
-     * @type {boolean}
-     */
-    editable?: boolean;
-    /**
-     * Object Super type
-     * @type {string}
-     */
-    superType?: string;
-    /**
-     * @description
-     * @type {string}
-     */
-    description?: string;
-    /**
-     * Animation property
-     * @type {AnimationProperty}
-     */
-    animation?: AnimationProperty;
-    /**
-     * Anime instance
-     * @type {anime.AnimeInstance}
-     */
-    anime?: anime.AnimeInstance;
-    /**
-     * Tooltip property
-     * @type {TooltipProperty}
-     */
-    tooltip?: TooltipProperty;
-    /**
-     * Link property
-     * @type {LinkProperty}
-     */
-    link?: LinkProperty;
-    /**
-     * Is running animation
-     * @type {boolean}
-     */
-    animating?: boolean;
-    /**
-     * Object class
-     * @type {string}
-     */
-    class?: string;
-    /**
-     * Is possible delete
-     * @type {boolean}
-     */
-    deletable?: boolean;
-    /**
-     * Is enable double click
-     * @type {boolean}
-     */
-    dblclick?: boolean;
-    /**
-     * Is possible clone
-     * @type {boolean}
-     */
-    cloneable?: boolean;
-    /**
-     * Is locked object
-     * @type {boolean}
-     */
-    locked?: boolean;
-    [key: string]: any;
-};
-export declare type FabricObject<T extends any = fabric.Object> = T & FabricObjectOption;
-export declare type FabricGroup = FabricObject<fabric.Group> & {
-    /**
-     * Object that config group
-     * @type {FabricObject[]}
-     */
-    objects?: FabricObject[];
-};
-export declare type FabricImage = FabricObject & fabric.Image & {
-    /**
-     * Image URL
-     * @type {string}
-     */
-    src?: string;
-    /**
-     * Image File or Blob
-     * @type {File}
-     */
-    file?: File;
-    /**
-     * Image Filter
-     * @type {IFilter[]}
-     */
-    filters?: IFilter[];
-};
-export interface FabricElement extends FabricObject<fabric.Rect> {
-    /**
-     * Wrapped Element
-     * @type {HTMLDivElement}
-     */
-    container: HTMLDivElement;
-    /**
-     * Target Element
-     * @type {HTMLDivElement}
-     */
-    element: HTMLDivElement;
-    /**
-     * Source of Element Object
-     */
-    setSource: (source: any) => void;
-}
-export declare type WorkareaLayout = 'fixed' | 'responsive' | 'fullscreen';
-export interface WorkareaOption {
-    /**
-     * Image URL
-     * @type {string}
-     */
-    src?: string;
-    /**
-     * Image File or Blbo
-     * @type {File}
-     */
-    file?: File;
-    /**
-     * Workarea Width
-     * @type {number}
-     */
-    width?: number;
-    /**
-     * Workarea Height
-     * @type {number}
-     */
-    height?: number;
-    /**
-     * Workarea Background Color
-     * @type {string}
-     */
-    backgroundColor?: string;
-    /**
-     * Workarea Layout Type
-     * @type {WorkareaLayout}
-     */
-    layout?: WorkareaLayout;
-}
-export declare type WorkareaObject = FabricImage & {
-    /**
-     * Workarea Layout Type
-     * @type {WorkareaLayout}
-     */
-    layout?: WorkareaLayout;
-    /**
-     * Workarea Image Element
-     * @type {HTMLImageElement}
-     */
-    _element?: HTMLImageElement;
-    /**
-     * Whether exist the element
-     * @type {boolean}
-     */
-    isElement?: boolean;
-    /**
-     * Stored width in workarea
-     * @type {number}
-     */
-    workareaWidth?: number;
-    /**
-     * Stored height in workarea
-     * @type {number}
-     */
-    workareaHeight?: number;
-};
-export interface CanvasOption {
-    /**
-     * Unique id of Canvas
-     * @type {string}
-     */
-    id?: string;
-    /**
-     * Indicates whether objects should remain in current stack position when selected. When false objects are brought to top and rendered as part of the selection group
-     * @type {boolean}
-     */
-    preserveObjectStacking?: boolean;
-    /**
-     * Canvas width
-     * @type {number}
-     */
-    width?: number;
-    /**
-     * Canvas height
-     * @type {number}
-     */
-    height?: number;
-    /**
-     * Whether group selection should be enabled
-     * @type {boolean}
-     */
-    selection?: boolean;
-    /**
-     * Default mouse cursor of Canvas
-     * @type {string}
-     */
-    defaultCursor?: string;
-    /**
-     * Background color of Canvas
-     * @type {(string | fabric.Pattern)}
-     */
-    backgroundColor?: string | fabric.Pattern;
-}
-export interface GridOption {
-    /**
-     * Whether should be enabled
-     * @type {boolean}
-     */
-    enabled?: boolean;
-    /**
-     * Grid interval
-     * @type {number}
-     */
-    grid?: number;
-    /**
-     * When had moved object, whether should adjust position on grid interval
-     * @type {boolean}
-     */
-    snapToGrid?: boolean;
-    /**
-     * Grid line color
-     *
-     * @type {string}
-     */
-    lineColor?: string;
-    /**
-     * Grid border color
-     *
-     * @type {string}
-     */
-    borderColor?: string;
-}
-export interface GuidelineOption {
-    /**
-     * When have moved object, whether should show guideline
-     * @type {boolean}
-     */
-    enabled?: boolean;
-}
-export interface KeyEvent {
-    /**
-     * Arrow key
-     * @type {boolean}
-     */
-    move?: boolean;
-    /**
-     * Ctrl + A
-     * @type {boolean}
-     */
-    all?: boolean;
-    /**
-     * Ctrl + C
-     * @type {boolean}
-     */
-    copy?: boolean;
-    /**
-     * Ctrl + P
-     * @type {boolean}
-     */
-    paste?: boolean;
-    /**
-     * Escape
-     * @type {boolean}
-     */
-    esc?: boolean;
-    /**
-     * Delete or Backspace
-     * @type {boolean}
-     */
-    del?: boolean;
-    /**
-     * When have copied object, whether should copy object option on clipboard
-     * @type {boolean}
-     */
-    clipboard?: boolean;
-    /**
-     * Ctrl + Z, Ctrl + Y
-     * @type {boolean}
-     */
-    transaction?: boolean;
-    /**
-     * Plus, Minus
-     *
-     * @type {boolean}
-     */
-    zoom?: boolean;
-    /**
-     * Ctrl + X
-     *
-     * @type {boolean}
-     */
-    cut?: boolean;
-}
-export declare type InteractionMode = 'selection' | 'grab' | 'polygon' | 'line' | 'arrow' | 'link' | 'crop';
-export interface FabricEvent<T extends any = Event> extends Omit<fabric.IEvent, 'e'> {
-    e: T;
-    target?: FabricObject;
-    subTargets?: FabricObject[];
-    button?: number;
-    isClick?: boolean;
-    pointer?: fabric.Point;
-    absolutePointer?: fabric.Point;
-    transform?: {
-        corner: string;
-        original: FabricObject;
-        originX: string;
-        originY: string;
-        width: number;
-    };
-}
-/**
- * toObject util
- * @param {*} obj
- * @param {string[]} propertiesToInclude
- * @param {{ [key: string]: any }} [properties]
- */
-export declare const toObject: (obj: any, propertiesToInclude: string[], properties?: {
-    [key: string]: any;
-}) => any;
+/// <reference types="animejs" />
+import { fabric } from 'fabric';
+import { IFilter } from '../handlers/ImageHandler';
+export declare type AnimationType = 'fade' | 'bounce' | 'shake' | 'scaling' | 'rotation' | 'flash' | 'custom' | 'none';
+export interface AnimationProperty {
+    delay?: number;
+    duration?: number;
+    autoplay?: boolean;
+    loop?: boolean | number;
+    type: AnimationType;
+    offset?: number;
+    opacity?: number;
+    bounce?: 'vertical' | 'horizontal';
+    shake?: 'vertical' | 'horizontal';
+    scale?: number;
+    angle?: number;
+    fill?: string | fabric.Pattern;
+    stroke?: string;
+}
+export interface LinkProperty {
+    enabled?: boolean;
+    type?: string;
+    state?: string;
+    [key: string]: any;
+}
+export interface TooltipProperty {
+    enabled?: boolean;
+    type?: string;
+    template?: string;
+}
+export interface TriggerProperty {
+    enabled?: boolean;
+    type?: string;
+    script?: string;
+    effect?: string;
+}
+export interface FabricCanvasOption {
+    wrapperEl?: HTMLElement;
+}
+export declare type FabricCanvas<T extends any = fabric.Canvas> = T & FabricCanvasOption;
+export declare type FabricObjectOption<T extends any = fabric.IObjectOptions> = T & {
+    /**
+     * Object id
+     * @type {string}
+     */
+    id?: string;
+    /**
+     * Parent object id
+     * @type {string}
+     */
+    parentId?: string;
+    /**
+     * Original opacity
+     * @type {number}
+     */
+    originOpacity?: number;
+    /**
+     * Original top position
+     * @type {number}
+     */
+    originTop?: number;
+    /**
+     * Original left position
+     * @type {number}
+     */
+    originLeft?: number;
+    /**
+     * Original scale X
+     * @type {number}
+     */
+    originScaleX?: number;
+    /**
+     * Original scale Y
+     * @type {number}
+     */
+    originScaleY?: number;
+    /**
+     * Original angle
+     * @type {number}
+     */
+    originAngle?: number;
+    /**
+     * Original fill color
+     * @type {(string | fabric.Pattern)}
+     */
+    originFill?: string | fabric.Pattern;
+    /**
+     * Original stroke color
+     * @type {string}
+     */
+    originStroke?: string;
+    /**
+     * Original rotation
+     *
+     * @type {number}
+     */
+    originRotation?: number;
+    /**
+     * Object editable
+     * @type {boolean}
+     */
+    editable?: boolean;
+    /**
+     * Object Super type
+     * @type {string}
+     */
+    superType?: string;
+    /**
+     * @description
+     * @type {string}
+     */
+    description?: string;
+    /**
+     * Animation property
+     * @type {AnimationProperty}
+     */
+    animation?: AnimationProperty;
+    /**
+     * Anime instance
+     * @type {anime.AnimeInstance}
+     */
+    anime?: anime.AnimeInstance;
+    /**
+     * Tooltip property
+     * @type {TooltipProperty}
+     */
+    tooltip?: TooltipProperty;
+    /**
+     * Link property
+     * @type {LinkProperty}
+     */
+    link?: LinkProperty;
+    /**
+     * Is running animation
+     * @type {boolean}
+     */
+    animating?: boolean;
+    /**
+     * Object class
+     * @type {string}
+     */
+    class?: string;
+    /**
+     * Is possible delete
+     * @type {boolean}
+     */
+    deletable?: boolean;
+    /**
+     * Is enable double click
+     * @type {boolean}
+     */
+    dblclick?: boolean;
+    /**
+     * Is possible clone
+     * @type {boolean}
+     */
+    cloneable?: boolean;
+    /**
+     * Is locked object
+     * @type {boolean}
+     */
+    locked?: boolean;
+    /**
+     * This property replaces "angle"
+     *
+     * @type {number}
+     */
+    rotation?: number;
+    /**
+     * Whether it can be clicked
+     *
+     * @type {boolean}
+     */
+    clickable?: boolean;
+    [key: string]: any;
+};
+export declare type FabricObject<T extends any = fabric.Object> = T & FabricObjectOption;
+export declare type FabricGroup = FabricObject<fabric.Group> & {
+    /**
+     * Object that config group
+     * @type {FabricObject[]}
+     */
+    objects?: FabricObject[];
+};
+export declare type FabricImage = FabricObject & fabric.Image & {
+    /**
+     * Image URL
+     * @type {string}
+     */
+    src?: string;
+    /**
+     * Image File or Blob
+     * @type {File}
+     */
+    file?: File;
+    /**
+     * Image Filter
+     * @type {IFilter[]}
+     */
+    filters?: IFilter[];
+    _element?: any;
+};
+export interface FabricElement extends FabricObject<fabric.Rect> {
+    /**
+     * Wrapped Element
+     * @type {HTMLDivElement}
+     */
+    container: HTMLDivElement;
+    /**
+     * Target Element
+     * @type {HTMLDivElement}
+     */
+    element: HTMLDivElement;
+    /**
+     * Source of Element Object
+     */
+    setSource: (source: any) => void;
+}
+export declare type WorkareaLayout = 'fixed' | 'responsive' | 'fullscreen';
+export interface WorkareaOption {
+    /**
+     * Image URL
+     * @type {string}
+     */
+    src?: string;
+    /**
+     * Image File or Blbo
+     * @type {File}
+     */
+    file?: File;
+    /**
+     * Workarea Width
+     * @type {number}
+     */
+    width?: number;
+    /**
+     * Workarea Height
+     * @type {number}
+     */
+    height?: number;
+    /**
+     * Workarea Background Color
+     * @type {string}
+     */
+    backgroundColor?: string;
+    /**
+     * Workarea Layout Type
+     * @type {WorkareaLayout}
+     */
+    layout?: WorkareaLayout;
+}
+export declare type WorkareaObject = FabricImage & {
+    /**
+     * Workarea Layout Type
+     * @type {WorkareaLayout}
+     */
+    layout?: WorkareaLayout;
+    /**
+     * Workarea Image Element
+     * @type {HTMLImageElement}
+     */
+    _element?: HTMLImageElement;
+    /**
+     * Whether exist the element
+     * @type {boolean}
+     */
+    isElement?: boolean;
+    /**
+     * Stored width in workarea
+     * @type {number}
+     */
+    workareaWidth?: number;
+    /**
+     * Stored height in workarea
+     * @type {number}
+     */
+    workareaHeight?: number;
+};
+export interface CanvasOption extends fabric.ICanvasOptions {
+    /**
+     * Unique id of Canvas
+     * @type {string}
+     */
+    id?: string;
+}
+export interface GridOption {
+    /**
+     * Whether should be enabled
+     * @type {boolean}
+     */
+    enabled?: boolean;
+    /**
+     * Grid interval
+     * @type {number}
+     */
+    grid?: number;
+    /**
+     * When had moved object, whether should adjust position on grid interval
+     * @type {boolean}
+     */
+    snapToGrid?: boolean;
+    /**
+     * Grid line color
+     *
+     * @type {string}
+     */
+    lineColor?: string;
+    /**
+     * Grid border color
+     *
+     * @type {string}
+     */
+    borderColor?: string;
+}
+export interface GuidelineOption {
+    /**
+     * When have moved object, whether should show guideline
+     * @type {boolean}
+     */
+    enabled?: boolean;
+}
+export interface KeyEvent {
+    /**
+     * Arrow key
+     * @type {boolean}
+     */
+    move?: boolean;
+    /**
+     * Ctrl + A
+     * @type {boolean}
+     */
+    all?: boolean;
+    /**
+     * Ctrl + C
+     * @type {boolean}
+     */
+    copy?: boolean;
+    /**
+     * Ctrl + P
+     * @type {boolean}
+     */
+    paste?: boolean;
+    /**
+     * Escape
+     * @type {boolean}
+     */
+    esc?: boolean;
+    /**
+     * Delete or Backspace
+     * @type {boolean}
+     */
+    del?: boolean;
+    /**
+     * When have copied object, whether should copy object option on clipboard
+     * @type {boolean}
+     */
+    clipboard?: boolean;
+    /**
+     * Ctrl + Z, Ctrl + Y
+     * @type {boolean}
+     */
+    transaction?: boolean;
+    /**
+     * Plus, Minus
+     *
+     * @type {boolean}
+     */
+    zoom?: boolean;
+    /**
+     * Ctrl + X
+     *
+     * @type {boolean}
+     */
+    cut?: boolean;
+    grab?: boolean;
+}
+export declare type InteractionMode = 'selection' | 'grab' | 'polygon' | 'line' | 'arrow' | 'link' | 'crop';
+export interface FabricEvent<T extends any = Event> extends Omit<fabric.IEvent, 'e'> {
+    e: T;
+    target?: FabricObject;
+    subTargets?: FabricObject[];
+    button?: number;
+    isClick?: boolean;
+    pointer?: fabric.Point;
+    absolutePointer?: fabric.Point;
+    transform?: {
+        corner: string;
+        original: FabricObject;
+        originX: string;
+        originY: string;
+        width: number;
+    };
+}
+export declare type FabricObjects = {
+    [key: string]: {
+        create: (...args: any) => FabricObject;
+    };
+};
+/**
+ * toObject util
+ * @param {*} obj
+ * @param {string[]} propertiesToInclude
+ * @param {{ [key: string]: any }} [properties]
+ */
+export declare const toObject: (obj: any, propertiesToInclude: string[], properties?: {
+    [key: string]: any;
+}) => any;