fabric 6.2.0 → 6.3.0

package/dist-extensions/src/shapes/IText/ITextClickBehavior.d.ts

@@ -0,0 +1,81 @@
+import type { TPointerEvent, TPointerEventInfo } from '../../EventTypeDefs';
+import type { XY } from '../../Point';
+import { DraggableTextDelegate } from './DraggableTextDelegate';
+import type { ITextEvents } from './ITextBehavior';
+import { ITextKeyBehavior } from './ITextKeyBehavior';
+import type { TOptions } from '../../typedefs';
+import type { TextProps, SerializedTextProps } from '../Text/Text';
+export declare abstract class ITextClickBehavior<Props extends TOptions<TextProps> = Partial<TextProps>, SProps extends SerializedTextProps = SerializedTextProps, EventSpec extends ITextEvents = ITextEvents> extends ITextKeyBehavior<Props, SProps, EventSpec> {
+    private __lastSelected;
+    private __lastClickTime;
+    private __lastLastClickTime;
+    private __lastPointer;
+    private __newClickTime;
+    protected draggableTextDelegate: DraggableTextDelegate;
+    initBehavior(): void;
+    /**
+     * If this method returns true a mouse move operation over a text selection
+     * will not prevent the native mouse event allowing the browser to start a drag operation.
+     * shouldStartDragging can be read 'do not prevent default for mouse move event'
+     * To prevent drag and drop between objects both shouldStartDragging and onDragStart should return false
+     * @returns
+     */
+    shouldStartDragging(): boolean;
+    /**
+     * @public override this method to control whether instance should/shouldn't become a drag source,
+     * @see also {@link DraggableTextDelegate#isActive}
+     * To prevent drag and drop between objects both shouldStartDragging and onDragStart should return false
+     * @returns {boolean} should handle event
+     */
+    onDragStart(e: DragEvent): boolean;
+    /**
+     * @public override this method to control whether instance should/shouldn't become a drop target
+     */
+    canDrop(e: DragEvent): boolean;
+    /**
+     * Default event handler to simulate triple click
+     * @private
+     */
+    onMouseDown(options: TPointerEventInfo): void;
+    isTripleClick(newPointer: XY): boolean;
+    /**
+     * Default handler for double click, select a word
+     */
+    doubleClickHandler(options: TPointerEventInfo): void;
+    /**
+     * Default handler for triple click, select a line
+     */
+    tripleClickHandler(options: TPointerEventInfo): void;
+    /**
+     * Default event handler for the basic functionalities needed on _mouseDown
+     * can be overridden to do something different.
+     * Scope of this implementation is: find the click position, set selectionStart
+     * find selectionEnd, initialize the drawing of either cursor or selection area
+     * initializing a mousedDown on a text area will cancel fabricjs knowledge of
+     * current compositionMode. It will be set to false.
+     */
+    _mouseDownHandler({ e }: TPointerEventInfo): void;
+    /**
+     * Default event handler for the basic functionalities needed on mousedown:before
+     * can be overridden to do something different.
+     * Scope of this implementation is: verify the object is already selected when mousing down
+     */
+    _mouseDownHandlerBefore({ e }: TPointerEventInfo): void;
+    /**
+     * standard handler for mouse up, overridable
+     * @private
+     */
+    mouseUpHandler({ e, transform }: TPointerEventInfo): void;
+    /**
+     * Changes cursor location in a text depending on passed pointer (x/y) object
+     * @param {TPointerEvent} e Event object
+     */
+    setCursorByClick(e: TPointerEvent): void;
+    /**
+     * Returns index of a character corresponding to where an object was clicked
+     * @param {TPointerEvent} e Event object
+     * @return {Number} Index of a character
+     */
+    getSelectionStartFromPointer(e: TPointerEvent): number;
+}
+//# sourceMappingURL=ITextClickBehavior.d.ts.map

package/dist-extensions/src/shapes/IText/ITextClickBehavior.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITextClickBehavior.d.ts","sourceRoot":"","sources":["../../../../src/shapes/IText/ITextClickBehavior.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAItC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAOnE,8BAAsB,kBAAkB,CACtC,KAAK,SAAS,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,EACtD,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,EACxD,SAAS,SAAS,WAAW,GAAG,WAAW,CAC3C,SAAQ,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC;IAClD,QAAgB,cAAc,CAAU;IACxC,QAAgB,eAAe,CAAS;IACxC,QAAgB,mBAAmB,CAAS;IAC5C,QAAgB,aAAa,CAA6B;IAC1D,QAAgB,cAAc,CAAS;IAEvC,SAAS,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;IAEvD,YAAY;IAqBZ;;;;;;OAMG;IACH,mBAAmB;IAInB;;;;;OAKG;IACH,WAAW,CAAC,CAAC,EAAE,SAAS;IAIxB;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,SAAS;IAIpB;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,iBAAiB;IAgBtC,aAAa,CAAC,UAAU,EAAE,EAAE;IAS5B;;OAEG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB;IAO7C;;OAEG;IACH,kBAAkB,CAAC,OAAO,EAAE,iBAAiB;IAO7C;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,CAAC,EAAE,EAAE,iBAAiB;IA8B1C;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,CAAC,EAAE,EAAE,iBAAiB;IAShD;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,iBAAiB;IAqClD;;;OAGG;IACH,gBAAgB,CAAC,CAAC,EAAE,aAAa;IAgBjC;;;;OAIG;IACH,4BAA4B,CAAC,CAAC,EAAE,aAAa,GAAG,MAAM;CAiDvD"}

package/dist-extensions/src/shapes/IText/ITextKeyBehavior.d.ts

@@ -0,0 +1,198 @@
+import type { ITextEvents } from './ITextBehavior';
+import { ITextBehavior } from './ITextBehavior';
+import type { TKeyMapIText } from './constants';
+import type { TOptions } from '../../typedefs';
+import type { TextProps, SerializedTextProps } from '../Text/Text';
+export declare abstract class ITextKeyBehavior<Props extends TOptions<TextProps> = Partial<TextProps>, SProps extends SerializedTextProps = SerializedTextProps, EventSpec extends ITextEvents = ITextEvents> extends ITextBehavior<Props, SProps, EventSpec> {
+    /**
+     * For functionalities on keyDown
+     * Map a special key to a function of the instance/prototype
+     * If you need different behavior for ESC or TAB or arrows, you have to change
+     * this map setting the name of a function that you build on the IText or
+     * your prototype.
+     * the map change will affect all Instances unless you need for only some text Instances
+     * in that case you have to clone this object and assign your Instance.
+     * this.keysMap = Object.assign({}, this.keysMap);
+     * The function must be in IText.prototype.myFunction And will receive event as args[0]
+     */
+    keysMap: TKeyMapIText;
+    keysMapRtl: TKeyMapIText;
+    /**
+     * For functionalities on keyUp + ctrl || cmd
+     */
+    ctrlKeysMapUp: TKeyMapIText;
+    /**
+     * For functionalities on keyDown + ctrl || cmd
+     */
+    ctrlKeysMapDown: TKeyMapIText;
+    hiddenTextarea: HTMLTextAreaElement | null;
+    /**
+     * DOM container to append the hiddenTextarea.
+     * An alternative to attaching to the document.body.
+     * Useful to reduce laggish redraw of the full document.body tree and
+     * also with modals event capturing that won't let the textarea take focus.
+     * @type HTMLElement
+     * @default
+     */
+    hiddenTextareaContainer?: HTMLElement | null;
+    private _clickHandlerInitialized;
+    private _copyDone;
+    private fromPaste;
+    /**
+     * Initializes hidden textarea (needed to bring up keyboard in iOS)
+     */
+    initHiddenTextarea(): void;
+    /**
+     * Override this method to customize cursor behavior on textbox blur
+     */
+    blur(): void;
+    /**
+     * Handles keydown event
+     * only used for arrows and combination of modifier keys.
+     * @param {KeyboardEvent} e Event object
+     */
+    onKeyDown(e: KeyboardEvent): void;
+    /**
+     * Handles keyup event
+     * We handle KeyUp because ie11 and edge have difficulties copy/pasting
+     * if a copy/cut event fired, keyup is dismissed
+     * @param {KeyboardEvent} e Event object
+     */
+    onKeyUp(e: KeyboardEvent): void;
+    /**
+     * Handles onInput event
+     * @param {Event} e Event object
+     */
+    onInput(this: this & {
+        hiddenTextarea: HTMLTextAreaElement;
+    }, e: Event): void;
+    /**
+     * Composition start
+     */
+    onCompositionStart(): void;
+    /**
+     * Composition end
+     */
+    onCompositionEnd(): void;
+    onCompositionUpdate({ target }: CompositionEvent): void;
+    /**
+     * Copies selected text
+     */
+    copy(): void;
+    /**
+     * Pastes text
+     */
+    paste(): void;
+    /**
+     * Finds the width in pixels before the cursor on the same line
+     * @private
+     * @param {Number} lineIndex
+     * @param {Number} charIndex
+     * @return {Number} widthBeforeCursor width before cursor
+     */
+    _getWidthBeforeCursor(lineIndex: number, charIndex: number): number;
+    /**
+     * Gets start offset of a selection
+     * @param {KeyboardEvent} e Event object
+     * @param {Boolean} isRight
+     * @return {Number}
+     */
+    getDownCursorOffset(e: KeyboardEvent, isRight: boolean): number;
+    /**
+     * private
+     * Helps finding if the offset should be counted from Start or End
+     * @param {KeyboardEvent} e Event object
+     * @param {Boolean} isRight
+     * @return {Number}
+     */
+    _getSelectionForOffset(e: KeyboardEvent, isRight: boolean): number;
+    /**
+     * @param {KeyboardEvent} e Event object
+     * @param {Boolean} isRight
+     * @return {Number}
+     */
+    getUpCursorOffset(e: KeyboardEvent, isRight: boolean): number;
+    /**
+     * for a given width it founds the matching character.
+     * @private
+     */
+    _getIndexOnLine(lineIndex: number, width: number): number;
+    /**
+     * Moves cursor down
+     * @param {KeyboardEvent} e Event object
+     */
+    moveCursorDown(e: KeyboardEvent): void;
+    /**
+     * Moves cursor up
+     * @param {KeyboardEvent} e Event object
+     */
+    moveCursorUp(e: KeyboardEvent): void;
+    /**
+     * Moves cursor up or down, fires the events
+     * @param {String} direction 'Up' or 'Down'
+     * @param {KeyboardEvent} e Event object
+     */
+    _moveCursorUpOrDown(direction: 'Up' | 'Down', e: KeyboardEvent): void;
+    /**
+     * Moves cursor with shift
+     * @param {Number} offset
+     */
+    moveCursorWithShift(offset: number): boolean;
+    /**
+     * Moves cursor up without shift
+     * @param {Number} offset
+     */
+    moveCursorWithoutShift(offset: number): boolean;
+    /**
+     * Moves cursor left
+     * @param {KeyboardEvent} e Event object
+     */
+    moveCursorLeft(e: KeyboardEvent): void;
+    /**
+     * @private
+     * @return {Boolean} true if a change happened
+     *
+     * @todo refactor not to use method name composition
+     */
+    _move(e: KeyboardEvent, prop: 'selectionStart' | 'selectionEnd', direction: 'Left' | 'Right'): boolean;
+    /**
+     * @private
+     */
+    _moveLeft(e: KeyboardEvent, prop: 'selectionStart' | 'selectionEnd'): boolean;
+    /**
+     * @private
+     */
+    _moveRight(e: KeyboardEvent, prop: 'selectionStart' | 'selectionEnd'): boolean;
+    /**
+     * Moves cursor left without keeping selection
+     * @param {KeyboardEvent} e
+     */
+    moveCursorLeftWithoutShift(e: KeyboardEvent): boolean;
+    /**
+     * Moves cursor left while keeping selection
+     * @param {KeyboardEvent} e
+     */
+    moveCursorLeftWithShift(e: KeyboardEvent): boolean | undefined;
+    /**
+     * Moves cursor right
+     * @param {KeyboardEvent} e Event object
+     */
+    moveCursorRight(e: KeyboardEvent): void;
+    /**
+     * Moves cursor right or Left, fires event
+     * @param {String} direction 'Left', 'Right'
+     * @param {KeyboardEvent} e Event object
+     */
+    _moveCursorLeftOrRight(direction: 'Left' | 'Right', e: KeyboardEvent): void;
+    /**
+     * Moves cursor right while keeping selection
+     * @param {KeyboardEvent} e
+     */
+    moveCursorRightWithShift(e: KeyboardEvent): boolean | undefined;
+    /**
+     * Moves cursor right without keeping selection
+     * @param {KeyboardEvent} e Event object
+     */
+    moveCursorRightWithoutShift(e: KeyboardEvent): boolean;
+}
+//# sourceMappingURL=ITextKeyBehavior.d.ts.map

package/dist-extensions/src/shapes/IText/ITextKeyBehavior.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITextKeyBehavior.d.ts","sourceRoot":"","sources":["../../../../src/shapes/IText/ITextKeyBehavior.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAMnE,8BAAsB,gBAAgB,CACpC,KAAK,SAAS,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,EACtD,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,EACxD,SAAS,SAAS,WAAW,GAAG,WAAW,CAC3C,SAAQ,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC;IAC/C;;;;;;;;;;OAUG;IACK,OAAO,EAAE,YAAY,CAAC;IAEtB,UAAU,EAAE,YAAY,CAAC;IAEjC;;OAEG;IACK,aAAa,EAAE,YAAY,CAAC;IAEpC;;OAEG;IACK,eAAe,EAAE,YAAY,CAAC;IAE9B,cAAc,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEnD;;;;;;;OAOG;IACK,uBAAuB,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAErD,QAAgB,wBAAwB,CAAU;IAClD,QAAgB,SAAS,CAAU;IACnC,QAAgB,SAAS,CAAU;IAEnC;;OAEG;IACH,kBAAkB;IAwClB;;OAEG;IACH,IAAI;IAIJ;;;;OAIG;IACH,SAAS,CAAC,CAAC,EAAE,aAAa;IA0B1B;;;;;OAKG;IACH,OAAO,CAAC,CAAC,EAAE,aAAa;IAgBxB;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG;QAAE,cAAc,EAAE,mBAAmB,CAAA;KAAE,EAAE,CAAC,EAAE,KAAK;IAwGtE;;OAEG;IACH,kBAAkB;IAIlB;;OAEG;IACH,gBAAgB;IAIhB,mBAAmB,CAAC,EAAE,MAAM,EAAE,EAAE,gBAAgB;IAOhD;;OAEG;IACH,IAAI;IAmBJ;;OAEG;IACH,KAAK;IAIL;;;;;;OAMG;IACH,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAWnE;;;;;OAKG;IACH,mBAAmB,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM;IAyB/D;;;;;;OAMG;IACH,sBAAsB,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM;IAQlE;;;;OAIG;IACH,iBAAiB,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM;IAsB7D;;;OAGG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IA+BhD;;;OAGG;IACH,cAAc,CAAC,CAAC,EAAE,aAAa;IAU/B;;;OAGG;IACH,YAAY,CAAC,CAAC,EAAE,aAAa;IAO7B;;;;OAIG;IACH,mBAAmB,CAAC,SAAS,EAAE,IAAI,GAAG,MAAM,EAAE,CAAC,EAAE,aAAa;IAuB9D;;;OAGG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM;IAalC;;;OAGG;IACH,sBAAsB,CAAC,MAAM,EAAE,MAAM;IAWrC;;;OAGG;IACH,cAAc,CAAC,CAAC,EAAE,aAAa;IAO/B;;;;;OAKG;IACH,KAAK,CACH,CAAC,EAAE,aAAa,EAChB,IAAI,EAAE,gBAAgB,GAAG,cAAc,EACvC,SAAS,EAAE,MAAM,GAAG,OAAO,GAC1B,OAAO;IAiBV;;OAEG;IACH,SAAS,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,gBAAgB,GAAG,cAAc;IAInE;;OAEG;IACH,UAAU,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,gBAAgB,GAAG,cAAc;IAIpE;;;OAGG;IACH,0BAA0B,CAAC,CAAC,EAAE,aAAa;IAgB3C;;;OAGG;IACH,uBAAuB,CAAC,CAAC,EAAE,aAAa;IAYxC;;;OAGG;IACH,eAAe,CAAC,CAAC,EAAE,aAAa;IAUhC;;;;OAIG;IACH,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,EAAE,CAAC,EAAE,aAAa;IAepE;;;OAGG;IACH,wBAAwB,CAAC,CAAC,EAAE,aAAa;IAYzC;;;OAGG;IACH,2BAA2B,CAAC,CAAC,EAAE,aAAa;CAY7C"}

package/dist-extensions/src/shapes/IText/constants.d.ts

@@ -0,0 +1,13 @@
+export type TKeyMapIText = Record<KeyboardEvent['keyCode'], CursorHandlingMethods>;
+export type CursorHandlingMethods = 'moveCursorUp' | 'moveCursorDown' | 'moveCursorLeft' | 'moveCursorRight' | 'exitEditing' | 'copy' | 'cut' | 'selectAll';
+export declare const keysMap: TKeyMapIText;
+export declare const keysMapRtl: TKeyMapIText;
+/**
+ * For functionalities on keyUp + ctrl || cmd
+ */
+export declare const ctrlKeysMapUp: TKeyMapIText;
+/**
+ * For functionalities on keyDown + ctrl || cmd
+ */
+export declare const ctrlKeysMapDown: TKeyMapIText;
+//# sourceMappingURL=constants.d.ts.map

package/dist-extensions/src/shapes/IText/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/shapes/IText/constants.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,MAAM,CAC/B,aAAa,CAAC,SAAS,CAAC,EACxB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAC7B,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,MAAM,GACN,KAAK,GACL,WAAW,CAAC;AAWhB,eAAO,MAAM,OAAO,EAAE,YAWrB,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,YAWxB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,YAI3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,YAE7B,CAAC"}

package/dist-extensions/src/shapes/Image.d.ts

@@ -0,0 +1,312 @@
+import type { BaseFilter } from '../filters/BaseFilter';
+import type { TClassProperties, TCrossOrigin, TSize, Abortable, TOptions } from '../typedefs';
+import type { LoadImageOptions } from '../util/misc/objectEnlive';
+import { FabricObject } from './Object/FabricObject';
+import type { FabricObjectProps, SerializedObjectProps } from './Object/types';
+import type { ObjectEvents } from '../EventTypeDefs';
+import type { CSSRules } from '../parser/typedefs';
+import type { Resize } from '../filters/Resize';
+import type { TCachedFabricObject } from './Object/Object';
+export type ImageSource = HTMLImageElement | HTMLVideoElement | HTMLCanvasElement;
+interface UniqueImageProps {
+    srcFromAttribute: boolean;
+    minimumScaleTrigger: number;
+    cropX: number;
+    cropY: number;
+    imageSmoothing: boolean;
+    filters: BaseFilter<string, Record<string, any>>[];
+    resizeFilter?: Resize;
+}
+export declare const imageDefaultValues: Partial<TClassProperties<FabricImage>>;
+export interface SerializedImageProps extends SerializedObjectProps {
+    src: string;
+    crossOrigin: TCrossOrigin;
+    filters: any[];
+    resizeFilter?: any;
+    cropX: number;
+    cropY: number;
+}
+export interface ImageProps extends FabricObjectProps, UniqueImageProps {
+}
+/**
+ * @tutorial {@link http://fabricjs.com/fabric-intro-part-1#images}
+ */
+export declare class FabricImage<Props extends TOptions<ImageProps> = Partial<ImageProps>, SProps extends SerializedImageProps = SerializedImageProps, EventSpec extends ObjectEvents = ObjectEvents> extends FabricObject<Props, SProps, EventSpec> implements ImageProps {
+    /**
+     * When calling {@link FabricImage.getSrc}, return value from element src with `element.getAttribute('src')`.
+     * This allows for relative urls as image src.
+     * @since 2.7.0
+     * @type Boolean
+     * @default false
+     */
+    srcFromAttribute: boolean;
+    /**
+     * private
+     * contains last value of scaleX to detect
+     * if the Image got resized after the last Render
+     * @type Number
+     */
+    protected _lastScaleX: number;
+    /**
+     * private
+     * contains last value of scaleY to detect
+     * if the Image got resized after the last Render
+     * @type Number
+     */
+    protected _lastScaleY: number;
+    /**
+     * private
+     * contains last value of scaling applied by the apply filter chain
+     * @type Number
+     */
+    protected _filterScalingX: number;
+    /**
+     * private
+     * contains last value of scaling applied by the apply filter chain
+     * @type Number
+     */
+    protected _filterScalingY: number;
+    /**
+     * minimum scale factor under which any resizeFilter is triggered to resize the image
+     * 0 will disable the automatic resize. 1 will trigger automatically always.
+     * number bigger than 1 are not implemented yet.
+     * @type Number
+     */
+    minimumScaleTrigger: number;
+    /**
+     * key used to retrieve the texture representing this image
+     * @since 2.0.0
+     * @type String
+     * @default
+     */
+    cacheKey: string;
+    /**
+     * Image crop in pixels from original image size.
+     * @since 2.0.0
+     * @type Number
+     * @default
+     */
+    cropX: number;
+    /**
+     * Image crop in pixels from original image size.
+     * @since 2.0.0
+     * @type Number
+     * @default
+     */
+    cropY: number;
+    /**
+     * Indicates whether this canvas will use image smoothing when painting this image.
+     * Also influence if the cacheCanvas for this image uses imageSmoothing
+     * @since 4.0.0-beta.11
+     * @type Boolean
+     * @default
+     */
+    imageSmoothing: boolean;
+    preserveAspectRatio: string;
+    protected src: string;
+    filters: BaseFilter<string, Record<string, any>>[];
+    resizeFilter: Resize;
+    _element: ImageSource;
+    _filteredEl?: HTMLCanvasElement;
+    _originalElement: ImageSource;
+    static type: string;
+    static cacheProperties: string[];
+    static ownDefaults: Partial<TClassProperties<FabricImage<Partial<ImageProps>, SerializedImageProps, ObjectEvents>>>;
+    static getDefaults(): Record<string, any>;
+    /**
+     * Constructor
+     * Image can be initialized with any canvas drawable or a string.
+     * The string should be a url and will be loaded as an image.
+     * Canvas and Image element work out of the box, while videos require extra code to work.
+     * Please check video element events for seeking.
+     * @param {ImageSource | string} element Image element
+     * @param {Object} [options] Options object
+     */
+    constructor(elementId: string, options?: Props);
+    constructor(element: ImageSource, options?: Props);
+    /**
+     * Returns image element which this instance if based on
+     */
+    getElement(): ImageSource;
+    /**
+     * Sets image element for this instance to a specified one.
+     * If filters defined they are applied to new image.
+     * You might need to call `canvas.renderAll` and `object.setCoords` after replacing, to render new image and update controls area.
+     * @param {HTMLImageElement} element
+     * @param {Partial<TSize>} [size] Options object
+     */
+    setElement(element: ImageSource, size?: Partial<TSize>): void;
+    /**
+     * Delete a single texture if in webgl mode
+     */
+    removeTexture(key: string): void;
+    /**
+     * Delete textures, reference to elements and eventually JSDOM cleanup
+     */
+    dispose(): void;
+    /**
+     * Get the crossOrigin value (of the corresponding image element)
+     */
+    getCrossOrigin(): string | null;
+    /**
+     * Returns original size of an image
+     */
+    getOriginalSize(): {
+        width: any;
+        height: any;
+    };
+    /**
+     * @private
+     * @param {CanvasRenderingContext2D} ctx Context to render on
+     */
+    _stroke(ctx: CanvasRenderingContext2D): void;
+    /**
+     * Returns object representation of an instance
+     * @param {Array} [propertiesToInclude] Any properties that you might want to additionally include in the output
+     * @return {Object} Object representation of an instance
+     */
+    toObject<T extends Omit<Props & TClassProperties<this>, keyof SProps>, K extends keyof T = never>(propertiesToInclude?: K[]): Pick<T, K> & SProps;
+    /**
+     * Returns true if an image has crop applied, inspecting values of cropX,cropY,width,height.
+     * @return {Boolean}
+     */
+    hasCrop(): boolean;
+    /**
+     * Returns svg representation of an instance
+     * @return {string[]} an array of strings with the specific svg representation
+     * of the instance
+     */
+    _toSVG(): string[];
+    /**
+     * Returns source of an image
+     * @param {Boolean} filtered indicates if the src is needed for svg
+     * @return {String} Source of an image
+     */
+    getSrc(filtered?: boolean): string;
+    /**
+     * Alias for getSrc
+     * @param filtered
+     * @deprecated
+     */
+    getSvgSrc(filtered?: boolean): string;
+    /**
+     * Loads and sets source of an image\
+     * **IMPORTANT**: It is recommended to abort loading tasks before calling this method to prevent race conditions and unnecessary networking
+     * @param {String} src Source string (URL)
+     * @param {LoadImageOptions} [options] Options object
+     */
+    setSrc(src: string, { crossOrigin, signal }?: LoadImageOptions): Promise<void>;
+    /**
+     * Returns string representation of an instance
+     * @return {String} String representation of an instance
+     */
+    toString(): string;
+    applyResizeFilters(): void;
+    /**
+     * Applies filters assigned to this image (from "filters" array) or from filter param
+     * @method applyFilters
+     * @param {Array} filters to be applied
+     * @param {Boolean} forResizing specify if the filter operation is a resize operation
+     */
+    applyFilters(filters?: BaseFilter<string, Record<string, any>>[]): void;
+    /**
+     * @private
+     * @param {CanvasRenderingContext2D} ctx Context to render on
+     */
+    _render(ctx: CanvasRenderingContext2D): void;
+    /**
+     * Paint the cached copy of the object on the target context.
+     * it will set the imageSmoothing for the draw operation
+     * @param {CanvasRenderingContext2D} ctx Context to render on
+     */
+    drawCacheOnCanvas(this: TCachedFabricObject<FabricImage>, ctx: CanvasRenderingContext2D): void;
+    /**
+     * Decide if the object should cache or not. Create its own cache level
+     * needsItsOwnCache should be used when the object drawing method requires
+     * a cache step. None of the fabric classes requires it.
+     * Generally you do not cache objects in groups because the group outside is cached.
+     * This is the special image version where we would like to avoid caching where possible.
+     * Essentially images do not benefit from caching. They may require caching, and in that
+     * case we do it. Also caching an image usually ends in a loss of details.
+     * A full performance audit should be done.
+     * @return {Boolean}
+     */
+    shouldCache(): boolean;
+    _renderFill(ctx: CanvasRenderingContext2D): void;
+    /**
+     * needed to check if image needs resize
+     * @private
+     */
+    _needsResize(): boolean;
+    /**
+     * @private
+     * @deprecated unused
+     */
+    _resetWidthHeight(): void;
+    /**
+     * @private
+     * Set the width and the height of the image object, using the element or the
+     * options.
+     */
+    _setWidthHeight({ width, height }?: Partial<TSize>): void;
+    /**
+     * Calculate offset for center and scale factor for the image in order to respect
+     * the preserveAspectRatio attribute
+     * @private
+     */
+    parsePreserveAspectRatioAttribute(): {
+        width: number;
+        height: number;
+        scaleX: number;
+        scaleY: number;
+        offsetLeft: number;
+        offsetTop: number;
+        cropX: number;
+        cropY: number;
+    };
+    /**
+     * Default CSS class name for canvas
+     * @static
+     * @type String
+     * @default
+     */
+    static CSS_CANVAS: string;
+    /**
+     * List of attribute names to account for when parsing SVG element (used by {@link FabricImage.fromElement})
+     * @static
+     * @see {@link http://www.w3.org/TR/SVG/struct.html#ImageElement}
+     */
+    static ATTRIBUTE_NAMES: string[];
+    /**
+     * Creates an instance of FabricImage from its object representation
+     * @static
+     * @param {Object} object Object to create an instance from
+     * @param {object} [options] Options object
+     * @param {AbortSignal} [options.signal] handle aborting, see https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal
+     * @returns {Promise<FabricImage>}
+     */
+    static fromObject<T extends TOptions<SerializedImageProps>>({ filters: f, resizeFilter: rf, src, crossOrigin, type, ...object }: T, options?: Abortable): Promise<FabricImage<Omit<T, "type" | "crossOrigin" | "filters" | "resizeFilter" | "src"> & {
+        src: string | undefined;
+        filters: BaseFilter<string, object>[];
+        resizeFilter: any;
+    }, SerializedImageProps, ObjectEvents>>;
+    /**
+     * Creates an instance of Image from an URL string
+     * @static
+     * @param {String} url URL to create an image from
+     * @param {LoadImageOptions} [options] Options object
+     * @returns {Promise<FabricImage>}
+     */
+    static fromURL<T extends TOptions<ImageProps>>(url: string, { crossOrigin, signal }?: LoadImageOptions, imageOptions?: T): Promise<FabricImage>;
+    /**
+     * Returns {@link FabricImage} instance from an SVG element
+     * @static
+     * @param {HTMLElement} element Element to parse
+     * @param {Object} [options] Options object
+     * @param {AbortSignal} [options.signal] handle aborting, see https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal
+     * @param {Function} callback Callback to execute when Image object is created
+     */
+    static fromElement(element: HTMLElement, options?: Abortable, cssRules?: CSSRules): Promise<FabricImage<Partial<ImageProps>, SerializedImageProps, ObjectEvents> | null>;
+}
+export {};
+//# sourceMappingURL=Image.d.ts.map

package/dist-extensions/src/shapes/Image.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Image.d.ts","sourceRoot":"","sources":["../../../src/shapes/Image.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAIxD,OAAO,KAAK,EACV,gBAAgB,EAChB,YAAY,EACZ,KAAK,EACL,SAAS,EACT,QAAQ,EACT,MAAM,aAAa,CAAC;AAIrB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAQlE,OAAO,EAAE,YAAY,EAAmB,MAAM,uBAAuB,CAAC;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAIrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAK3D,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,CAAC;AAEtB,UAAU,gBAAgB;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,OAAO,CAAC;IACxB,OAAO,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;IACnD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,kBAAkB,EAAE,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAOrE,CAAC;AAEF,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,YAAY,CAAC;IAC1B,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAW,SAAQ,iBAAiB,EAAE,gBAAgB;CAAG;AAI1E;;GAEG;AACH,qBAAa,WAAW,CACpB,KAAK,SAAS,QAAQ,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,EACxD,MAAM,SAAS,oBAAoB,GAAG,oBAAoB,EAC1D,SAAS,SAAS,YAAY,GAAG,YAAY,CAE/C,SAAQ,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAC7C,YAAW,UAAU;IAErB;;;;;;OAMG;IACK,gBAAgB,EAAE,OAAO,CAAC;IAElC;;;;;OAKG;IACH,SAAS,CAAC,WAAW,SAAK;IAE1B;;;;;OAKG;IACH,SAAS,CAAC,WAAW,SAAK;IAE1B;;;;OAIG;IACH,SAAS,CAAC,eAAe,SAAK;IAE9B;;;;OAIG;IACH,SAAS,CAAC,eAAe,SAAK;IAE9B;;;;;OAKG;IACK,mBAAmB,EAAE,MAAM,CAAC;IAEpC;;;;;OAKG;IACK,QAAQ,EAAE,MAAM,CAAC;IAEzB;;;;;OAKG;IACK,KAAK,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACK,KAAK,EAAE,MAAM,CAAC;IAEtB;;;;;;OAMG;IACK,cAAc,EAAE,OAAO,CAAC;IAExB,mBAAmB,EAAE,MAAM,CAAC;IAEpC,UAAkB,GAAG,EAAE,MAAM,CAAC;IAEtB,OAAO,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;IACnD,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,WAAW,CAAC;IACtB,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,gBAAgB,EAAE,WAAW,CAAC;IAEtC,MAAM,CAAC,IAAI,SAAW;IAEtB,MAAM,CAAC,eAAe,WAAwC;IAE9D,MAAM,CAAC,WAAW,kGAAsB;IAExC,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAMzC;;;;;;;;OAQG;gBACS,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK;gBAClC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,KAAK;IAkBjD;;OAEG;IACH,UAAU;IAIV;;;;;;OAMG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,GAAE,OAAO,CAAC,KAAK,CAAM;IAmB1D;;OAEG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM;IAOzB;;OAEG;IACH,OAAO;IAeP;;OAEG;IACH,cAAc,IAAI,MAAM,GAAG,IAAI;IAO/B;;OAEG;IACH,eAAe;;;;IAcf;;;OAGG;IACH,OAAO,CAAC,GAAG,EAAE,wBAAwB;IAerC;;;;OAIG;IACH,QAAQ,CACN,CAAC,SAAS,IAAI,CAAC,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,MAAM,CAAC,EAC5D,CAAC,SAAS,MAAM,CAAC,GAAG,KAAK,EACzB,mBAAmB,GAAE,CAAC,EAAO,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM;IAgBrD;;;OAGG;IACH,OAAO;IASP;;;;OAIG;IACH,MAAM;IAiEN;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM;IAiBlC;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO;IAI5B;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,GAAE,gBAAqB;IAOlE;;;OAGG;IACH,QAAQ;IAIR,kBAAkB;IAqClB;;;;;OAKG;IACH,YAAY,CACV,OAAO,GAAE,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAuB;IA6DzE;;;OAGG;IACH,OAAO,CAAC,GAAG,EAAE,wBAAwB;IASrC;;;;OAIG;IACH,iBAAiB,CACf,IAAI,EAAE,mBAAmB,CAAC,WAAW,CAAC,EACtC,GAAG,EAAE,wBAAwB;IAM/B;;;;;;;;;;OAUG;IACH,WAAW;IAIX,WAAW,CAAC,GAAG,EAAE,wBAAwB;IA+BzC;;;OAGG;IACH,YAAY;IAKZ;;;OAGG;IACH,iBAAiB;IAIjB;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAE,OAAO,CAAC,KAAK,CAAM;IAMtD;;;;OAIG;IACH,iCAAiC;;;;;;;;;;IAsEjC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,SAAgB;IAEjC;;;;OAIG;IACH,MAAM,CAAC,eAAe,WAUpB;IAEF;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,QAAQ,CAAC,oBAAoB,CAAC,EACxD,EAAE,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,EACtE,OAAO,CAAC,EAAE,SAAS;;;;;IAoBrB;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,QAAQ,CAAC,UAAU,CAAC,EAC3C,GAAG,EAAE,MAAM,EACX,EAAE,WAAkB,EAAE,MAAM,EAAE,GAAE,gBAAqB,EACrD,YAAY,CAAC,EAAE,CAAC,GACf,OAAO,CAAC,WAAW,CAAC;IAMvB;;;;;;;OAOG;WACU,WAAW,CACtB,OAAO,EAAE,WAAW,EACpB,OAAO,GAAE,SAAc,EACvB,QAAQ,CAAC,EAAE,QAAQ;CAgBtB"}