fabric 6.2.0 → 6.3.0

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

@@ -0,0 +1,122 @@
+import type { Abortable, TClassProperties, TOptions } from '../typedefs';
+import { FabricObject } from './Object/FabricObject';
+import { Point } from '../Point';
+import type { FabricObjectProps, SerializedObjectProps } from './Object/types';
+import type { ObjectEvents } from '../EventTypeDefs';
+import type { CSSRules } from '../parser/typedefs';
+interface UniqueLineProps {
+    x1: number;
+    x2: number;
+    y1: number;
+    y2: number;
+}
+export interface SerializedLineProps extends SerializedObjectProps, UniqueLineProps {
+}
+export declare class Line<Props extends TOptions<FabricObjectProps> = Partial<FabricObjectProps>, SProps extends SerializedLineProps = SerializedLineProps, EventSpec extends ObjectEvents = ObjectEvents> extends FabricObject<Props, SProps, EventSpec> implements UniqueLineProps {
+    /**
+     * x value or first line edge
+     * @type number
+     * @default
+     */
+    x1: number;
+    /**
+     * y value or first line edge
+     * @type number
+     * @default
+     */
+    y1: number;
+    /**
+     * x value or second line edge
+     * @type number
+     * @default
+     */
+    x2: number;
+    /**
+     * y value or second line edge
+     * @type number
+     * @default
+     */
+    y2: number;
+    static type: string;
+    static cacheProperties: string[];
+    /**
+     * Constructor
+     * @param {Array} [points] Array of points
+     * @param {Object} [options] Options object
+     * @return {Line} thisArg
+     */
+    constructor([x1, y1, x2, y2]?: [number, number, number, number], options?: Partial<Props>);
+    /**
+     * @private
+     * @param {Object} [options] Options
+     */
+    _setWidthHeight(): void;
+    /**
+     * @private
+     * @param {String} key
+     * @param {*} value
+     */
+    _set(key: string, value: any): this;
+    /**
+     * @private
+     * @param {CanvasRenderingContext2D} ctx Context to render on
+     */
+    _render(ctx: CanvasRenderingContext2D): void;
+    /**
+     * This function is an helper for svg import. it returns the center of the object in the svg
+     * untransformed coordinates
+     * @private
+     * @return {Point} center point from element coordinates
+     */
+    _findCenterFromElement(): Point;
+    /**
+     * Returns object representation of an instance
+     * @method toObject
+     * @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;
+    _getNonTransformedDimensions(): Point;
+    /**
+     * Recalculates line points given width and height
+     * Those points are simply placed around the center,
+     * This is not useful outside internal render functions and svg output
+     * Is not meant to be for the developer.
+     * @private
+     */
+    calcLinePoints(): UniqueLineProps;
+    /**
+     * Returns svg representation of an instance
+     * @return {Array} an array of strings with the specific svg representation
+     * of the instance
+     */
+    _toSVG(): string[];
+    /**
+     * List of attribute names to account for when parsing SVG element (used by {@link Line.fromElement})
+     * @static
+     * @memberOf Line
+     * @see http://www.w3.org/TR/SVG/shapes.html#LineElement
+     */
+    static ATTRIBUTE_NAMES: string[];
+    /**
+     * Returns Line instance from an SVG element
+     * @static
+     * @memberOf Line
+     * @param {HTMLElement} element Element to parse
+     * @param {Object} [options] Options object
+     * @param {Function} [callback] callback function invoked after parsing
+     */
+    static fromElement(element: HTMLElement, options: Abortable, cssRules?: CSSRules): Promise<Line<{
+        [x: string]: any;
+    }, SerializedLineProps, ObjectEvents>>;
+    /**
+     * Returns Line instance from an object representation
+     * @static
+     * @memberOf Line
+     * @param {Object} object Object to create an instance from
+     * @returns {Promise<Line>}
+     */
+    static fromObject<T extends TOptions<SerializedLineProps>>({ x1, y1, x2, y2, ...object }: T): Promise<Line<Partial<FabricObjectProps>, SerializedLineProps, ObjectEvents>>;
+}
+export {};
+//# sourceMappingURL=Line.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Line.d.ts","sourceRoot":"","sources":["../../../src/shapes/Line.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEzE,OAAO,EAAE,YAAY,EAAmB,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,OAAO,KAAK,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAMnD,UAAU,eAAe;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,mBACf,SAAQ,qBAAqB,EAC3B,eAAe;CAAG;AAEtB,qBAAa,IAAI,CACb,KAAK,SAAS,QAAQ,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,EACtE,MAAM,SAAS,mBAAmB,GAAG,mBAAmB,EACxD,SAAS,SAAS,YAAY,GAAG,YAAY,CAE/C,SAAQ,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAC7C,YAAW,eAAe;IAE1B;;;;OAIG;IACK,EAAE,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACK,EAAE,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACK,EAAE,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACK,EAAE,EAAE,MAAM,CAAC;IAEnB,MAAM,CAAC,IAAI,SAAU;IAErB,MAAM,CAAC,eAAe,WAAuC;IAC7D;;;;;OAKG;gBACS,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,mCAAe,EAAE,OAAO,GAAE,OAAO,CAAC,KAAK,CAAM;IAczE;;;OAGG;IACH,eAAe;IAYf;;;;OAIG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAc5B;;;OAGG;IACH,OAAO,CAAC,GAAG,EAAE,wBAAwB;IAsBrC;;;;;OAKG;IACH,sBAAsB,IAAI,KAAK;IAI/B;;;;;OAKG;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;IAWrD,4BAA4B,IAAI,KAAK;IAarC;;;;;;OAMG;IACH,cAAc,IAAI,eAAe;IAmBjC;;;;OAIG;IACH,MAAM;IASN;;;;;OAKG;IACH,MAAM,CAAC,eAAe,WAAwC;IAE9D;;;;;;;OAOG;WACU,WAAW,CACtB,OAAO,EAAE,WAAW,EACpB,OAAO,EAAE,SAAS,EAClB,QAAQ,CAAC,EAAE,QAAQ;;;IAcrB;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,QAAQ,CAAC,mBAAmB,CAAC,EAAE,EACzD,EAAE,EACF,EAAE,EACF,EAAE,EACF,EAAE,EACF,GAAG,MAAM,EACV,EAAE,CAAC;CAWL"}

package/dist-extensions/src/shapes/Object/AnimatableObject.d.ts

@@ -0,0 +1,33 @@
+import type { TColorArg } from '../../color/typedefs';
+import type { ObjectEvents } from '../../EventTypeDefs';
+import type { TAnimation } from '../../util/animation/animate';
+import type { AnimationOptions } from '../../util/animation/types';
+import { StackedObject } from './StackedObject';
+export declare abstract class AnimatableObject<EventSpec extends ObjectEvents = ObjectEvents> extends StackedObject<EventSpec> {
+    /**
+     * List of properties to consider for animating colors.
+     * @type String[]
+     */
+    static colorProperties: string[];
+    /**
+     * Animates object's properties
+     * @param {Record<string, number | number[] | TColorArg>} animatable map of keys and end values
+     * @param {Partial<AnimationOptions<T>>} options
+     * @tutorial {@link http://fabricjs.com/fabric-intro-part-2#animation}
+     * @return {Record<string, TAnimation<T>>} map of animation contexts
+     *
+     * As object — multiple properties
+     *
+     * object.animate({ left: ..., top: ... });
+     * object.animate({ left: ..., top: ... }, { duration: ... });
+     */
+    animate<T extends number | number[] | TColorArg>(animatable: Record<string, T>, options?: Partial<AnimationOptions<T>>): Record<string, TAnimation<T>>;
+    /**
+     * @private
+     * @param {String} key Property to animate
+     * @param {String} to Value to animate to
+     * @param {Object} [options] Options object
+     */
+    _animate<T extends number | number[] | TColorArg>(key: string, endValue: T, options?: Partial<AnimationOptions<T>>): TAnimation<T>;
+}
+//# sourceMappingURL=AnimatableObject.d.ts.map

package/dist-extensions/src/shapes/Object/AnimatableObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnimatableObject.d.ts","sourceRoot":"","sources":["../../../../src/shapes/Object/AnimatableObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE/D,OAAO,KAAK,EACV,gBAAgB,EAIjB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,8BAAsB,gBAAgB,CACpC,SAAS,SAAS,YAAY,GAAG,YAAY,CAC7C,SAAQ,aAAa,CAAC,SAAS,CAAC;IAChC;;;OAGG;IACH,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,CAAqC;IAErE;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,EAC7C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAC7B,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GACrC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAUhC;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,EAC9C,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,CAAC,EACX,OAAO,GAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAM,GACzC,UAAU,CAAC,CAAC,CAAC;CAiDjB"}

package/dist-extensions/src/shapes/Object/FabricObject.d.ts

@@ -0,0 +1,11 @@
+import type { ObjectEvents } from '../../EventTypeDefs';
+import { FabricObjectSVGExportMixin } from './FabricObjectSVGExportMixin';
+import { InteractiveFabricObject } from './InteractiveObject';
+import type { FabricObjectProps } from './types/FabricObjectProps';
+import type { TFabricObjectProps, SerializedObjectProps } from './types';
+export interface FabricObject<Props extends TFabricObjectProps = Partial<FabricObjectProps>, SProps extends SerializedObjectProps = SerializedObjectProps, EventSpec extends ObjectEvents = ObjectEvents> extends FabricObjectSVGExportMixin {
+}
+export declare class FabricObject<Props extends TFabricObjectProps = Partial<FabricObjectProps>, SProps extends SerializedObjectProps = SerializedObjectProps, EventSpec extends ObjectEvents = ObjectEvents> extends InteractiveFabricObject<Props, SProps, EventSpec> {
+}
+export { cacheProperties } from './defaultValues';
+//# sourceMappingURL=FabricObject.d.ts.map

package/dist-extensions/src/shapes/Object/FabricObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FabricObject.d.ts","sourceRoot":"","sources":["../../../../src/shapes/Object/FabricObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAE9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAMzE,MAAM,WAAW,YAAY,CAE3B,KAAK,SAAS,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,EAE7D,MAAM,SAAS,qBAAqB,GAAG,qBAAqB,EAE5D,SAAS,SAAS,YAAY,GAAG,YAAY,CAC7C,SAAQ,0BAA0B;CAAG;AAGvC,qBAAa,YAAY,CACvB,KAAK,SAAS,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,EAC7D,MAAM,SAAS,qBAAqB,GAAG,qBAAqB,EAC5D,SAAS,SAAS,YAAY,GAAG,YAAY,CAC7C,SAAQ,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC;CAAG;AAO9D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC"}

package/dist-extensions/src/shapes/Object/FabricObjectSVGExportMixin.d.ts

@@ -0,0 +1,72 @@
+import type { TSVGReviver } from '../../typedefs';
+import type { FabricObject } from './FabricObject';
+export declare class FabricObjectSVGExportMixin {
+    /**
+     * When an object is being exported as SVG as a clippath, a reference inside the SVG is needed.
+     * This reference is a UID in the fabric namespace and is temporary stored here.
+     * @type {String}
+     */
+    clipPathId?: string;
+    /**
+     * Returns styles-string for svg-export
+     * @param {Boolean} skipShadow a boolean to skip shadow filter output
+     * @return {String}
+     */
+    getSvgStyles(this: FabricObjectSVGExportMixin & FabricObject, skipShadow?: boolean): string;
+    /**
+     * Returns filter for svg shadow
+     * @return {String}
+     */
+    getSvgFilter(this: FabricObjectSVGExportMixin & FabricObject): string;
+    /**
+     * Returns id attribute for svg output
+     * @return {String}
+     */
+    getSvgCommons(this: FabricObjectSVGExportMixin & FabricObject & {
+        id?: string;
+    }): string;
+    /**
+     * Returns transform-string for svg-export
+     * @param {Boolean} use the full transform or the single object one.
+     * @return {String}
+     */
+    getSvgTransform(this: FabricObjectSVGExportMixin & FabricObject, full?: boolean, additionalTransform?: string): string;
+    /**
+     * Returns svg representation of an instance
+     * This function is implemented in each subclass
+     * This is just because typescript otherwise cryies all the time
+     * @return {Array} an array of strings with the specific svg representation
+     * of the instance
+     */
+    _toSVG(_reviver?: TSVGReviver): string[];
+    /**
+     * Returns svg representation of an instance
+     * @param {TSVGReviver} [reviver] Method for further parsing of svg representation.
+     * @return {String} svg representation of an instance
+     */
+    toSVG(this: FabricObjectSVGExportMixin & FabricObject, reviver?: TSVGReviver): string;
+    /**
+     * Returns svg clipPath representation of an instance
+     * @param {TSVGReviver} [reviver] Method for further parsing of svg representation.
+     * @return {String} svg representation of an instance
+     */
+    toClipPathSVG(this: FabricObjectSVGExportMixin & FabricObject, reviver?: TSVGReviver): string;
+    /**
+     * @private
+     */
+    _createBaseClipPathSVGMarkup(this: FabricObjectSVGExportMixin & FabricObject, objectMarkup: string[], { reviver, additionalTransform, }?: {
+        reviver?: TSVGReviver;
+        additionalTransform?: string;
+    }): string;
+    /**
+     * @private
+     */
+    _createBaseSVGMarkup(this: FabricObjectSVGExportMixin & FabricObject, objectMarkup: string[], { noStyle, reviver, withShadow, additionalTransform, }?: {
+        noStyle?: boolean;
+        reviver?: TSVGReviver;
+        withShadow?: boolean;
+        additionalTransform?: string;
+    }): string;
+    addPaintOrder(this: FabricObjectSVGExportMixin & FabricObject): string;
+}
+//# sourceMappingURL=FabricObjectSVGExportMixin.d.ts.map

package/dist-extensions/src/shapes/Object/FabricObjectSVGExportMixin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FabricObjectSVGExportMixin.d.ts","sourceRoot":"","sources":["../../../../src/shapes/Object/FabricObjectSVGExportMixin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAIlD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGnD,qBAAa,0BAA0B;IACrC;;;;OAIG;IACK,UAAU,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,YAAY,CACV,IAAI,EAAE,0BAA0B,GAAG,YAAY,EAC/C,UAAU,CAAC,EAAE,OAAO;IAiDtB;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,0BAA0B,GAAG,YAAY;IAI5D;;;OAGG;IACH,aAAa,CACX,IAAI,EAAE,0BAA0B,GAAG,YAAY,GAAG;QAAE,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE;IAanE;;;;OAIG;IACH,eAAe,CACb,IAAI,EAAE,0BAA0B,GAAG,YAAY,EAC/C,IAAI,CAAC,EAAE,OAAO,EACd,mBAAmB,SAAK;IAO1B;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,MAAM,EAAE;IAIxC;;;;OAIG;IACH,KAAK,CACH,IAAI,EAAE,0BAA0B,GAAG,YAAY,EAC/C,OAAO,CAAC,EAAE,WAAW;IAOvB;;;;OAIG;IACH,aAAa,CACX,IAAI,EAAE,0BAA0B,GAAG,YAAY,EAC/C,OAAO,CAAC,EAAE,WAAW;IAUvB;;OAEG;IACH,4BAA4B,CAC1B,IAAI,EAAE,0BAA0B,GAAG,YAAY,EAC/C,YAAY,EAAE,MAAM,EAAE,EACtB,EACE,OAAO,EACP,mBAAwB,GACzB,GAAE;QAAE,OAAO,CAAC,EAAE,WAAW,CAAC;QAAC,mBAAmB,CAAC,EAAE,MAAM,CAAA;KAAO;IAYjE;;OAEG;IACH,oBAAoB,CAClB,IAAI,EAAE,0BAA0B,GAAG,YAAY,EAC/C,YAAY,EAAE,MAAM,EAAE,EACtB,EACE,OAAO,EACP,OAAO,EACP,UAAU,EACV,mBAAmB,GACpB,GAAE;QACD,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,CAAC,EAAE,WAAW,CAAC;QACtB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;KACzB,GACL,MAAM;IAwDT,aAAa,CAAC,IAAI,EAAE,0BAA0B,GAAG,YAAY;CAG9D"}

package/dist-extensions/src/shapes/Object/InteractiveObject.d.ts

@@ -0,0 +1,317 @@
+import { Point } from '../../Point';
+import type { TCornerPoint, TDegree } from '../../typedefs';
+import { FabricObject } from './Object';
+import type { TQrDecomposeOut } from '../../util/misc/matrix';
+import type { Control } from '../../controls/Control';
+import type { ObjectEvents, TPointerEvent } from '../../EventTypeDefs';
+import type { Canvas } from '../../canvas/Canvas';
+import type { ControlRenderingStyleOverride } from '../../controls/controlRendering';
+import type { FabricObjectProps } from './types/FabricObjectProps';
+import type { TFabricObjectProps, SerializedObjectProps } from './types';
+export type TOCoord = Point & {
+    corner: TCornerPoint;
+    touchCorner: TCornerPoint;
+};
+export type TControlSet = Record<string, Control>;
+export type TBorderRenderingStyleOverride = Partial<Pick<InteractiveFabricObject, 'borderColor' | 'borderDashArray'>>;
+export type TStyleOverride = ControlRenderingStyleOverride & TBorderRenderingStyleOverride & Partial<Pick<InteractiveFabricObject, 'hasBorders' | 'hasControls'> & {
+    forActiveSelection: boolean;
+}>;
+export declare class InteractiveFabricObject<Props extends TFabricObjectProps = Partial<FabricObjectProps>, SProps extends SerializedObjectProps = SerializedObjectProps, EventSpec extends ObjectEvents = ObjectEvents> extends FabricObject<Props, SProps, EventSpec> implements FabricObjectProps {
+    noScaleCache: boolean;
+    snapAngle?: TDegree;
+    snapThreshold?: TDegree;
+    lockMovementX: boolean;
+    lockMovementY: boolean;
+    lockRotation: boolean;
+    lockScalingX: boolean;
+    lockScalingY: boolean;
+    lockSkewingX: boolean;
+    lockSkewingY: boolean;
+    lockScalingFlip: boolean;
+    cornerSize: number;
+    touchCornerSize: number;
+    transparentCorners: boolean;
+    cornerColor: string;
+    cornerStrokeColor: string;
+    cornerStyle: 'rect' | 'circle';
+    cornerDashArray: number[] | null;
+    hasControls: boolean;
+    borderColor: string;
+    borderDashArray: number[] | null;
+    borderOpacityWhenMoving: number;
+    borderScaleFactor: number;
+    hasBorders: boolean;
+    selectionBackgroundColor: string;
+    selectable: boolean;
+    evented: boolean;
+    perPixelTargetFind: boolean;
+    activeOn: 'down' | 'up';
+    hoverCursor: CSSStyleDeclaration['cursor'] | null;
+    moveCursor: CSSStyleDeclaration['cursor'] | null;
+    /**
+     * The object's controls' position in viewport coordinates
+     * Calculated by {@link Control#positionHandler} and {@link Control#calcCornerCoords}, depending on {@link padding}.
+     * `corner/touchCorner` describe the 4 points forming the interactive area of the corner.
+     * Used to draw and locate controls.
+     */
+    oCoords: Record<string, TOCoord>;
+    /**
+     * keeps the value of the last hovered corner during mouse move.
+     * 0 is no corner, or 'mt', 'ml', 'mtr' etc..
+     * It should be private, but there is no harm in using it as
+     * a read-only property.
+     * this isn't cleaned automatically. Non selected objects may have wrong values
+     * @type [string]
+     */
+    __corner?: string;
+    /**
+     * a map of control visibility for this object.
+     * this was left when controls were introduced to not break the api too much
+     * this takes priority over the generic control visibility
+     */
+    _controlsVisibility: Record<string, boolean>;
+    /**
+     * holds the controls for the object.
+     * controls are added by default_controls.js
+     */
+    controls: TControlSet;
+    /**
+     * internal boolean to signal the code that the object is
+     * part of the move action.
+     */
+    isMoving?: boolean;
+    /**
+     * A boolean used from the gesture module to keep tracking of a scaling
+     * action when there is no scaling transform in place.
+     * This is an edge case and is used twice in all codebase.
+     * Probably added to keep track of some performance issues
+     * @TODO use git blame to investigate why it was added
+     * DON'T USE IT. WE WILL TRY TO REMOVE IT
+     */
+    _scaling?: boolean;
+    canvas?: Canvas;
+    static ownDefaults: Partial<import("../../typedefs").TClassProperties<InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>>>;
+    static getDefaults(): Record<string, any>;
+    /**
+     * Constructor
+     * @param {Object} [options] Options object
+     */
+    constructor(options?: Props);
+    /**
+     * Creates the default control object.
+     * If you prefer to have on instance of controls shared among all objects
+     * make this function return an empty object and add controls to the ownDefaults
+     * @param {Object} [options] Options object
+     */
+    static createControls(): {
+        controls: Record<string, Control>;
+    };
+    /**
+     * Update width and height of the canvas for cache
+     * returns true or false if canvas needed resize.
+     * @private
+     * @return {Boolean} true if the canvas has been resized
+     */
+    _updateCacheCanvas(): boolean;
+    getActiveControl(): {
+        key: string;
+        control: Control;
+        coord: TOCoord;
+    } | undefined;
+    /**
+     * Determines which corner is under the mouse cursor, represented by `pointer`.
+     * This function is return a corner only if the object is the active one.
+     * This is done to avoid selecting corner of non active object and activating transformations
+     * rather than drag action. The default behavior of fabricJS is that if you want to transform
+     * an object, first you select it to show the control set
+     * @private
+     * @param {Object} pointer The pointer indicating the mouse position
+     * @param {boolean} forTouch indicates if we are looking for interaction area with a touch action
+     * @return {String|Boolean} corner code (tl, tr, bl, br, etc.), or 0 if nothing is found.
+     */
+    findControl(pointer: Point, forTouch?: boolean): {
+        key: string;
+        control: Control;
+        coord: TOCoord;
+    } | undefined;
+    /**
+     * Calculates the coordinates of the center of each control plus the corners of the control itself
+     * This basically just delegates to each control positionHandler
+     * WARNING: changing what is passed to positionHandler is a breaking change, since position handler
+     * is a public api and should be done just if extremely necessary
+     * @return {Record<string, TOCoord>}
+     */
+    calcOCoords(): Record<string, TOCoord>;
+    /**
+     * Sets the coordinates that determine the interaction area of each control
+     * note: if we would switch to ROUND corner area, all of this would disappear.
+     * everything would resolve to a single point and a pythagorean theorem for the distance
+     * @todo evaluate simplification of code switching to circle interaction area at runtime
+     * @private
+     */
+    private _calcCornerCoords;
+    /**
+     * @override set controls' coordinates as well
+     * See {@link https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords} and {@link http://fabricjs.com/fabric-gotchas}
+     * @return {void}
+     */
+    setCoords(): void;
+    /**
+     * Calls a function for each control. The function gets called,
+     * with the control, the control's key and the object that is calling the iterator
+     * @param {Function} fn function to iterate over the controls over
+     */
+    forEachControl(fn: (control: Control, key: string, fabricObject: InteractiveFabricObject) => any): void;
+    /**
+     * Draws a colored layer behind the object, inside its selection borders.
+     * Requires public options: padding, selectionBackgroundColor
+     * this function is called when the context is transformed
+     * has checks to be skipped when the object is on a staticCanvas
+     * @todo evaluate if make this disappear in favor of a pre-render hook for objects
+     * this was added by Andrea Bogazzi to make possible some feature for work reasons
+     * it seemed a good option, now is an edge case
+     * @param {CanvasRenderingContext2D} ctx Context to draw on
+     */
+    drawSelectionBackground(ctx: CanvasRenderingContext2D): void;
+    /**
+     * @public override this function in order to customize the drawing of the control box, e.g. rounded corners, different border style.
+     * @param {CanvasRenderingContext2D} ctx ctx is rotated and translated so that (0,0) is at object's center
+     * @param {Point} size the control box size used
+     */
+    strokeBorders(ctx: CanvasRenderingContext2D, size: Point): void;
+    /**
+     * @private
+     * @param {CanvasRenderingContext2D} ctx Context to draw on
+     * @param {Point} size
+     * @param {TStyleOverride} styleOverride object to override the object style
+     */
+    _drawBorders(ctx: CanvasRenderingContext2D, size: Point, styleOverride?: TStyleOverride): void;
+    /**
+     * Renders controls and borders for the object
+     * the context here is not transformed
+     * @todo move to interactivity
+     * @param {CanvasRenderingContext2D} ctx Context to render on
+     * @param {TStyleOverride} [styleOverride] properties to override the object style
+     */
+    _renderControls(ctx: CanvasRenderingContext2D, styleOverride?: TStyleOverride): void;
+    /**
+     * Draws borders of an object's bounding box.
+     * Requires public properties: width, height
+     * Requires public options: padding, borderColor
+     * @param {CanvasRenderingContext2D} ctx Context to draw on
+     * @param {object} options object representing current object parameters
+     * @param {TStyleOverride} [styleOverride] object to override the object style
+     */
+    drawBorders(ctx: CanvasRenderingContext2D, options: TQrDecomposeOut, styleOverride: TStyleOverride): void;
+    /**
+     * Draws lines from a borders of an object's bounding box to controls that have `withConnection` property set.
+     * Requires public properties: width, height
+     * Requires public options: padding, borderColor
+     * @param {CanvasRenderingContext2D} ctx Context to draw on
+     * @param {Point} size object size x = width, y = height
+     */
+    drawControlsConnectingLines(ctx: CanvasRenderingContext2D, size: Point): void;
+    /**
+     * Draws corners of an object's bounding box.
+     * Requires public properties: width, height
+     * Requires public options: cornerSize, padding
+     * Be aware that since fabric 6.0 this function does not call setCoords anymore.
+     * setCoords needs to be called manually if the object of which we are rendering controls
+     * is outside the standard selection and transform process.
+     * @param {CanvasRenderingContext2D} ctx Context to draw on
+     * @param {ControlRenderingStyleOverride} styleOverride object to override the object style
+     */
+    drawControls(ctx: CanvasRenderingContext2D, styleOverride?: ControlRenderingStyleOverride): void;
+    /**
+     * Returns true if the specified control is visible, false otherwise.
+     * @param {string} controlKey The key of the control. Possible values are usually 'tl', 'tr', 'br', 'bl', 'ml', 'mt', 'mr', 'mb', 'mtr',
+     * but since the control api allow for any control name, can be any string.
+     * @returns {boolean} true if the specified control is visible, false otherwise
+     */
+    isControlVisible(controlKey: string): boolean;
+    /**
+     * Sets the visibility of the specified control.
+     * please do not use.
+     * @param {String} controlKey The key of the control. Possible values are 'tl', 'tr', 'br', 'bl', 'ml', 'mt', 'mr', 'mb', 'mtr'.
+     * but since the control api allow for any control name, can be any string.
+     * @param {Boolean} visible true to set the specified control visible, false otherwise
+     * @todo discuss this overlap of priority here with the team. Andrea Bogazzi for details
+     */
+    setControlVisible(controlKey: string, visible: boolean): void;
+    /**
+     * Sets the visibility state of object controls, this is just a bulk option for setControlVisible;
+     * @param {Record<string, boolean>} [options] with an optional key per control
+     * example: {Boolean} [options.bl] true to enable the bottom-left control, false to disable it
+     */
+    setControlsVisibility(options?: Record<string, boolean>): void;
+    /**
+     * Clears the canvas.contextTop in a specific area that corresponds to the object's bounding box
+     * that is in the canvas.contextContainer.
+     * This function is used to clear pieces of contextTop where we render ephemeral effects on top of the object.
+     * Example: blinking cursor text selection, drag effects.
+     * @todo discuss swapping restoreManually with a renderCallback, but think of async issues
+     * @param {Boolean} [restoreManually] When true won't restore the context after clear, in order to draw something else.
+     * @return {CanvasRenderingContext2D|undefined} canvas.contextTop that is either still transformed
+     * with the object transformMatrix, or restored to neutral transform
+     */
+    clearContextTop(restoreManually?: boolean): CanvasRenderingContext2D | undefined;
+    /**
+     * This callback function is called every time _discardActiveObject or _setActiveObject
+     * try to to deselect this object. If the function returns true, the process is cancelled
+     * @param {Object} [_options] options sent from the upper functions
+     * @param {TPointerEvent} [options.e] event if the process is generated by an event
+     * @param {FabricObject} [options.object] next object we are setting as active, and reason why
+     * this is being deselected
+     */
+    onDeselect(_options?: {
+        e?: TPointerEvent;
+        object?: InteractiveFabricObject;
+    }): boolean;
+    /**
+     * This callback function is called every time _discardActiveObject or _setActiveObject
+     * try to to select this object. If the function returns true, the process is cancelled
+     * @param {Object} [_options] options sent from the upper functions
+     * @param {Event} [_options.e] event if the process is generated by an event
+     */
+    onSelect(_options?: {
+        e?: TPointerEvent;
+    }): boolean;
+    /**
+     * Override to customize Drag behavior
+     * Fired from {@link Canvas#_onMouseMove}
+     * @returns true in order for the window to start a drag session
+     */
+    shouldStartDragging(_e: TPointerEvent): boolean;
+    /**
+     * Override to customize Drag behavior\
+     * Fired once a drag session has started
+     * @returns true to handle the drag event
+     */
+    onDragStart(_e: DragEvent): boolean;
+    /**
+     * Override to customize drag and drop behavior
+     * @public
+     * @param {DragEvent} _e
+     * @returns {boolean} true if the object currently dragged can be dropped on the target
+     */
+    canDrop(_e: DragEvent): boolean;
+    /**
+     * Override to customize drag and drop behavior
+     * render a specific effect when an object is the source of a drag event
+     * example: render the selection status for the part of text that is being dragged from a text object
+     * @public
+     * @param {DragEvent} _e
+     */
+    renderDragSourceEffect(_e: DragEvent): void;
+    /**
+     * Override to customize drag and drop behavior
+     * render a specific effect when an object is the target of a drag event
+     * used to show that the underly object can receive a drop, or to show how the
+     * object will change when dropping. example: show the cursor where the text is about to be dropped
+     * @public
+     * @param {DragEvent} _e
+     */
+    renderDropTargetEffect(_e: DragEvent): void;
+}
+//# sourceMappingURL=InteractiveObject.d.ts.map

package/dist-extensions/src/shapes/Object/InteractiveObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InteractiveObject.d.ts","sourceRoot":"","sources":["../../../../src/shapes/Object/InteractiveObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAQ,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAQ9D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEtD,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAKzE,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG;IAC5B,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,YAAY,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAElD,MAAM,MAAM,6BAA6B,GAAG,OAAO,CACjD,IAAI,CAAC,uBAAuB,EAAE,aAAa,GAAG,iBAAiB,CAAC,CACjE,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,6BAA6B,GACxD,6BAA6B,GAC7B,OAAO,CACL,IAAI,CAAC,uBAAuB,EAAE,YAAY,GAAG,aAAa,CAAC,GAAG;IAC5D,kBAAkB,EAAE,OAAO,CAAC;CAC7B,CACF,CAAC;AAEJ,qBAAa,uBAAuB,CAChC,KAAK,SAAS,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,EAC7D,MAAM,SAAS,qBAAqB,GAAG,qBAAqB,EAC5D,SAAS,SAAS,YAAY,GAAG,YAAY,CAE/C,SAAQ,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAC7C,YAAW,iBAAiB;IAEpB,YAAY,EAAE,OAAO,CAAC;IAEtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC;IACvB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,EAAE,OAAO,CAAC;IAEzB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC/B,eAAe,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACjC,WAAW,EAAE,OAAO,CAAC;IAErB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACjC,uBAAuB,EAAE,MAAM,CAAC;IAChC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,OAAO,CAAC;IACpB,wBAAwB,EAAE,MAAM,CAAC;IAEjC,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,WAAW,EAAE,mBAAmB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAClD,UAAU,EAAE,mBAAmB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEzD;;;;;OAKG;IACK,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;;;;;;OAOG;IACK,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACK,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErD;;;OAGG;IACK,QAAQ,EAAE,WAAW,CAAC;IAE9B;;;OAGG;IACK,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;;;;OAOG;IACK,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAExB,MAAM,CAAC,WAAW,+IAAkC;IAEpD,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAOzC;;;OAGG;gBACS,OAAO,CAAC,EAAE,KAAK;IAU3B;;;;;OAKG;IACH,MAAM,CAAC,cAAc,IAAI;QAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE;IAI9D;;;;;OAKG;IACH,kBAAkB;IAiBlB,gBAAgB;;;;;IAWhB;;;;;;;;;;OAUG;IACH,WAAW,CACT,OAAO,EAAE,KAAK,EACd,QAAQ,UAAQ,GACf;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS;IA6BhE;;;;;;OAMG;IACH,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAuDtC;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAqBzB;;;;OAIG;IACH,SAAS,IAAI,IAAI;IAKjB;;;;OAIG;IACH,cAAc,CACZ,EAAE,EAAE,CACF,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,uBAAuB,KAClC,GAAG;IAOV;;;;;;;;;OASG;IACH,uBAAuB,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI;IAmB5D;;;;OAIG;IACH,aAAa,CAAC,GAAG,EAAE,wBAAwB,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI;IAI/D;;;;;OAKG;IACH,YAAY,CACV,GAAG,EAAE,wBAAwB,EAC7B,IAAI,EAAE,KAAK,EACX,aAAa,GAAE,cAAmB,GACjC,IAAI;IAeP;;;;;;OAMG;IACH,eAAe,CACb,GAAG,EAAE,wBAAwB,EAC7B,aAAa,GAAE,cAAmB;IAiCpC;;;;;;;OAOG;IACH,WAAW,CACT,GAAG,EAAE,wBAAwB,EAC7B,OAAO,EAAE,eAAe,EACxB,aAAa,EAAE,cAAc,GAC5B,IAAI;IA4BP;;;;;;OAMG;IACH,2BAA2B,CACzB,GAAG,EAAE,wBAAwB,EAC7B,IAAI,EAAE,KAAK,GACV,IAAI;IAoBP;;;;;;;;;OASG;IACH,YAAY,CACV,GAAG,EAAE,wBAAwB,EAC7B,aAAa,GAAE,6BAAkC;IA0BnD;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAO7C;;;;;;;OAOG;IACH,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAOtD;;;;OAIG;IACH,qBAAqB,CAAC,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;IAM3D;;;;;;;;;OASG;IACH,eAAe,CACb,eAAe,CAAC,EAAE,OAAO,GACxB,wBAAwB,GAAG,SAAS;IAqBvC;;;;;;;OAOG;IACH,UAAU,CAAC,QAAQ,CAAC,EAAE;QACpB,CAAC,CAAC,EAAE,aAAa,CAAC;QAClB,MAAM,CAAC,EAAE,uBAAuB,CAAC;KAClC,GAAG,OAAO;IAKX;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO;IAKnD;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,EAAE,aAAa;IAIrC;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,SAAS;IAIzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO;IAI/B;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,EAAE,SAAS;IAIpC;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,EAAE,SAAS;CAGrC"}