fabric 5.3.0 → 6.0.0-beta1

package/dist/src/parser/constants.d.ts

@@ -0,0 +1,54 @@
+export declare const cssRules: {};
+export declare const gradientDefs: {};
+export declare const clipPaths: {};
+export declare const storage: {
+    cssRules: {};
+    gradientDefs: {};
+    clipPaths: {};
+};
+export declare const reNum = "(?:[-+]?(?:\\d+|\\d*\\.\\d+)(?:[eE][-+]?\\d+)?)";
+export declare const svgNS = "http://www.w3.org/2000/svg";
+export declare const commaWsp = "(?:\\s+,?\\s*|,\\s*)";
+export declare const rePathCommand: RegExp;
+export declare const reFontDeclaration: RegExp;
+export declare const svgValidTagNames: string[], svgViewBoxElements: string[], svgInvalidAncestors: string[], svgValidParents: string[], attributesMap: {
+    cx: string;
+    x: string;
+    r: string;
+    cy: string;
+    y: string;
+    display: string;
+    visibility: string;
+    transform: string;
+    'fill-opacity': string;
+    'fill-rule': string;
+    'font-family': string;
+    'font-size': string;
+    'font-style': string;
+    'font-weight': string;
+    'letter-spacing': string;
+    'paint-order': string;
+    'stroke-dasharray': string;
+    'stroke-dashoffset': string;
+    'stroke-linecap': string;
+    'stroke-linejoin': string;
+    'stroke-miterlimit': string;
+    'stroke-opacity': string;
+    'stroke-width': string;
+    'text-decoration': string;
+    'text-anchor': string;
+    opacity: string;
+    'clip-path': string;
+    'clip-rule': string;
+    'vector-effect': string;
+    'image-rendering': string;
+}, colorAttributes: {
+    stroke: string;
+    fill: string;
+}, fSize = "font-size", cPath = "clip-path";
+export declare const svgValidTagNamesRegEx: RegExp;
+export declare const svgViewBoxElementsRegEx: RegExp;
+export declare const svgInvalidAncestorsRegEx: RegExp;
+export declare const svgValidParentsRegEx: RegExp;
+export declare const reViewBoxAttrValue: RegExp;
+//# sourceMappingURL=constants.d.ts.map

package/dist/src/parser/doesSomeParentMatch.d.ts

@@ -0,0 +1,2 @@
+export declare function doesSomeParentMatch(element: any, selectors: any): boolean;
+//# sourceMappingURL=doesSomeParentMatch.d.ts.map

package/dist/src/parser/elementById.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @private
+ * to support IE8 missing getElementById on SVGdocument and on node xmlDOM
+ */
+export declare function elementById(doc: any, id: any): any;
+//# sourceMappingURL=elementById.d.ts.map

package/dist/src/parser/elementMatchesRule.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+export declare function elementMatchesRule(element: any, selectors: any): boolean;
+//# sourceMappingURL=elementMatchesRule.d.ts.map

package/dist/src/parser/elements_parser.d.ts

@@ -0,0 +1,3 @@
+declare const ElementsParser: (elements: any, callback: any, options: any, reviver: any, parsingOptions: any, doc: any) => void;
+export { ElementsParser };
+//# sourceMappingURL=elements_parser.d.ts.map

package/dist/src/parser/getCSSRules.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns CSS rules for a given SVG document
+ * @param {SVGDocument} doc SVG document to parse
+ * @return {Object} CSS rules of this document
+ */
+export declare function getCSSRules(doc: any): {};
+//# sourceMappingURL=getCSSRules.d.ts.map

package/dist/src/parser/getGlobalStylesForElement.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @private
+ */
+export declare function getGlobalStylesForElement(element: any, svgUid: any): {};
+//# sourceMappingURL=getGlobalStylesForElement.d.ts.map

package/dist/src/parser/getGradientDefs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Parses an SVG document, returning all of the gradient declarations found in it
+ * @param {SVGDocument} doc SVG document to parse
+ * @return {Object} Gradient definitions; key corresponds to element id, value -- to gradient definition element
+ */
+export declare function getGradientDefs(doc: any): {};
+//# sourceMappingURL=getGradientDefs.d.ts.map

package/dist/src/parser/getMultipleNodes.d.ts

@@ -0,0 +1,2 @@
+export declare function getMultipleNodes(doc: any, nodeNames: any): any[];
+//# sourceMappingURL=getMultipleNodes.d.ts.map

package/dist/src/parser/getSvgRegex.d.ts

@@ -0,0 +1,2 @@
+export declare function getSvgRegex(arr: any): RegExp;
+//# sourceMappingURL=getSvgRegex.d.ts.map

package/dist/src/parser/hasAncestorWithNodeName.d.ts

@@ -0,0 +1,2 @@
+export declare function hasAncestorWithNodeName(element: any, nodeName: any): boolean;
+//# sourceMappingURL=hasAncestorWithNodeName.d.ts.map

package/dist/src/parser/loadSVGFromString.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Takes string corresponding to an SVG document, and parses it into a set of fabric objects
+ * @memberOf fabric
+ * @param {String} string
+ * @param {Function} callback
+ * @param {Function} [reviver] Method for further parsing of SVG elements, called after each fabric object created.
+ * @param {Object} [options] Object containing options for parsing
+ * @param {String} [options.crossOrigin] crossOrigin crossOrigin setting to use for external resources
+ * @param {AbortSignal} [options.signal] handle aborting, see https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal
+ */
+export declare function loadSVGFromString(string: any, callback: any, reviver: any, options: any): void;
+//# sourceMappingURL=loadSVGFromString.d.ts.map

package/dist/src/parser/loadSVGFromURL.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Takes url corresponding to an SVG document, and parses it into a set of fabric objects.
+ * Note that SVG is fetched via XMLHttpRequest, so it needs to conform to SOP (Same Origin Policy)
+ * @memberOf fabric
+ * @param {String} url
+ * @param {Function} callback
+ * @param {Function} [reviver] Method for further parsing of SVG elements, called after each fabric object created.
+ * @param {Object} [options] Object containing options for parsing
+ * @param {String} [options.crossOrigin] crossOrigin crossOrigin setting to use for external resources
+ * @param {AbortSignal} [options.signal] handle aborting, see https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal
+ */
+export declare function loadSVGFromURL(url: any, callback: any, reviver: any, options: any): void;
+//# sourceMappingURL=loadSVGFromURL.d.ts.map

package/dist/src/parser/normalizeAttr.d.ts

@@ -0,0 +1,2 @@
+export declare function normalizeAttr(attr: any): any;
+//# sourceMappingURL=normalizeAttr.d.ts.map

package/dist/src/parser/normalizeValue.d.ts

@@ -0,0 +1,2 @@
+export declare function normalizeValue(attr: any, value: any, parentAttributes: any, fontSize: any): any;
+//# sourceMappingURL=normalizeValue.d.ts.map

package/dist/src/parser/parseAttributes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns an object of attributes' name/value, given element and an array of attribute names;
+ * Parses parent "g" nodes recursively upwards.
+ * @param {SVGElement | HTMLElement} element Element to parse
+ * @param {Array} attributes Array of attributes to parse
+ * @return {Object} object containing parsed attributes' names/values
+ */
+export declare function parseAttributes(element: SVGElement | HTMLElement, attributes: string[], svgUid?: string): Record<string, any>;
+//# sourceMappingURL=parseAttributes.d.ts.map

package/dist/src/parser/parseElements.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Transforms an array of svg elements to corresponding fabric.* instances
+ * @static
+ * @memberOf fabric
+ * @param {Array} elements Array of elements to parse
+ * @param {Function} callback Being passed an array of fabric instances (transformed from SVG elements)
+ * @param {Object} [options] Options object
+ * @param {Function} [reviver] Method for further parsing of SVG elements, called after each fabric object created.
+ */
+export declare function parseElements(elements: any, callback: any, options: any, reviver: any, parsingOptions: any): void;
+//# sourceMappingURL=parseElements.d.ts.map

package/dist/src/parser/parseFontDeclaration.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parses a short font declaration, building adding its properties to a style object
+ * @static
+ * @function
+ * @memberOf fabric
+ * @param {String} value font declaration
+ * @param {Object} oStyle definition
+ */
+export declare function parseFontDeclaration(value: any, oStyle: any): void;
+//# sourceMappingURL=parseFontDeclaration.d.ts.map

package/dist/src/parser/parsePointsAttribute.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Parses "points" attribute, returning an array of values
+ * @static
+ * @memberOf fabric
+ * @param {String} points points attribute string
+ * @return {Array} array of points
+ */
+export declare function parsePointsAttribute(points: any): {
+    x: number;
+    y: number;
+}[] | null;
+//# sourceMappingURL=parsePointsAttribute.d.ts.map

package/dist/src/parser/parseSVGDocument.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Parses an SVG document, converts it to an array of corresponding fabric.* instances and passes them to a callback
+ * @static
+ * @function
+ * @memberOf fabric
+ * @param {SVGDocument} doc SVG document to parse
+ * @param {Function} callback Callback to call when parsing is finished;
+ * It's being passed an array of elements (parsed from a document).
+ * @param {Function} [reviver] Method for further parsing of SVG elements, called after each fabric object created.
+ * @param {Object} [parsingOptions] options for parsing document
+ * @param {String} [parsingOptions.crossOrigin] crossOrigin settings
+ * @param {AbortSignal} [parsingOptions.signal] see https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal
+ */
+export declare function parseSVGDocument(doc: any, callback: any, reviver: any, parsingOptions: any): void;
+//# sourceMappingURL=parseSVGDocument.d.ts.map

package/dist/src/parser/parseStyleAttribute.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parses "style" attribute, retuning an object with values
+ * @static
+ * @memberOf fabric
+ * @param {SVGElement} element Element to parse
+ * @return {Object} Objects with values parsed from style attribute of an element
+ */
+export declare function parseStyleAttribute(element: any): {};
+//# sourceMappingURL=parseStyleAttribute.d.ts.map

package/dist/src/parser/parseStyleObject.d.ts

@@ -0,0 +1,2 @@
+export declare function parseStyleObject(style: any, oStyle: any): void;
+//# sourceMappingURL=parseStyleObject.d.ts.map

package/dist/src/parser/parseStyleString.d.ts

@@ -0,0 +1,2 @@
+export declare function parseStyleString(style: any, oStyle: any): void;
+//# sourceMappingURL=parseStyleString.d.ts.map

package/dist/src/parser/parseTransformAttribute.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parses "transform" attribute, returning an array of values
+ * @static
+ * @function
+ * @memberOf fabric
+ * @param {String} attributeValue String containing attribute value
+ * @return {Array} Array of 6 elements representing transformation matrix
+ */
+export declare function parseTransformAttribute(attributeValue: any): any;
+//# sourceMappingURL=parseTransformAttribute.d.ts.map

package/dist/src/parser/parseUseDirectives.d.ts

@@ -0,0 +1,2 @@
+export declare function parseUseDirectives(doc: any): void;
+//# sourceMappingURL=parseUseDirectives.d.ts.map

package/dist/src/parser/percent.d.ts

@@ -0,0 +1,9 @@
+export declare function isPercent(value: string | null): boolean | "" | null;
+/**
+ *
+ * @param value
+ * @param valueIfNaN
+ * @returns ∈ [0, 1]
+ */
+export declare function parsePercent(value: string | number | null | undefined, valueIfNaN?: number): number;
+//# sourceMappingURL=percent.d.ts.map

package/dist/src/parser/recursivelyParseGradientsXlink.d.ts

@@ -0,0 +1,2 @@
+export declare function recursivelyParseGradientsXlink(doc: any, gradient: any): void;
+//# sourceMappingURL=recursivelyParseGradientsXlink.d.ts.map

package/dist/src/parser/rotateMatrix.d.ts

@@ -0,0 +1,2 @@
+export declare function rotateMatrix(matrix: any, args: any): void;
+//# sourceMappingURL=rotateMatrix.d.ts.map

package/dist/src/parser/scaleMatrix.d.ts

@@ -0,0 +1,2 @@
+export declare function scaleMatrix(matrix: any, args: any): void;
+//# sourceMappingURL=scaleMatrix.d.ts.map

package/dist/src/parser/selectorMatches.d.ts

@@ -0,0 +1,2 @@
+export declare function selectorMatches(element: any, selector: any): boolean;
+//# sourceMappingURL=selectorMatches.d.ts.map

package/dist/src/parser/setStrokeFillOpacity.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @private
+ * @param {Object} attributes Array of attributes to parse
+ */
+export declare function setStrokeFillOpacity(attributes: any): any;
+//# sourceMappingURL=setStrokeFillOpacity.d.ts.map

package/dist/src/parser/skewMatrix.d.ts

@@ -0,0 +1,2 @@
+export declare function skewMatrix(matrix: any, args: any, pos: any): void;
+//# sourceMappingURL=skewMatrix.d.ts.map

package/dist/src/parser/translateMatrix.d.ts

@@ -0,0 +1,2 @@
+export declare function translateMatrix(matrix: any, args: any): void;
+//# sourceMappingURL=translateMatrix.d.ts.map

package/dist/src/shapes/ActiveSelection.d.ts

@@ -0,0 +1,66 @@
+import { ControlRenderingStyleOverride } from '../controls/controls.render';
+import { TClassProperties } from '../typedefs';
+import { Group } from './Group';
+import type { FabricObject } from './Object/FabricObject';
+export declare class ActiveSelection extends Group {
+    _objects: FabricObject[];
+    constructor(objects?: FabricObject[], options?: any, objectsRelativeToGroup?: boolean);
+    /**
+     * @private
+     */
+    _shouldSetNestedCoords(): boolean;
+    /**
+     * @private
+     * @param {FabricObject} object
+     * @param {boolean} [removeParentTransform] true if object is in canvas coordinate plane
+     * @returns {boolean} true if object entered group
+     */
+    enterGroup(object: FabricObject, removeParentTransform?: boolean): boolean;
+    /**
+     * we want objects to retain their canvas ref when exiting instance
+     * @private
+     * @param {FabricObject} object
+     * @param {boolean} [removeParentTransform] true if object should exit group without applying group's transform to it
+     */
+    exitGroup(object: FabricObject, removeParentTransform?: boolean): void;
+    /**
+     * @private
+     * @param {'added'|'removed'} type
+     * @param {FabricObject[]} targets
+     */
+    _onAfterObjectsChange(type: 'added' | 'removed', targets: FabricObject[]): void;
+    /**
+     * If returns true, deselection is cancelled.
+     * @since 2.0.0
+     * @return {Boolean} [cancel]
+     */
+    onDeselect(): boolean;
+    /**
+     * Returns string representation of a group
+     * @return {String}
+     */
+    toString(): string;
+    /**
+     * Decide if the object should cache or not. Create its own cache level
+     * objectCaching is a global flag, wins over everything
+     * 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.
+     * @return {Boolean}
+     */
+    shouldCache(): boolean;
+    /**
+     * Check if this group or its parent group are caching, recursively up
+     * @return {Boolean}
+     */
+    isOnACache(): boolean;
+    /**
+     * Renders controls and borders for the object
+     * @param {CanvasRenderingContext2D} ctx Context to render on
+     * @param {Object} [styleOverride] properties to override the object style
+     * @param {Object} [childrenOverride] properties to override the children overrides
+     */
+    _renderControls(ctx: CanvasRenderingContext2D, styleOverride?: ControlRenderingStyleOverride, childrenOverride?: ControlRenderingStyleOverride): void;
+}
+export declare const activeSelectionDefaultValues: Partial<TClassProperties<ActiveSelection>>;
+//# sourceMappingURL=ActiveSelection.d.ts.map

package/dist/src/shapes/Circle.d.ts

@@ -0,0 +1,80 @@
+import { FabricObject } from './Object/FabricObject';
+import { TClassProperties } from '../typedefs';
+export declare class Circle extends FabricObject {
+    /**
+     * Radius of this circle
+     * @type Number
+     * @default 0
+     */
+    radius: number;
+    /**
+     * degrees of start of the circle.
+     * probably will change to degrees in next major version
+     * @type Number 0 - 359
+     * @default 0
+     */
+    startAngle: number;
+    /**
+     * End angle of the circle
+     * probably will change to degrees in next major version
+     * @type Number 1 - 360
+     * @default 360
+     */
+    endAngle: number;
+    /**
+     * @private
+     * @param {String} key
+     * @param {*} value
+     */
+    _set(key: string, value: any): this;
+    /**
+     * @private
+     * @param {CanvasRenderingContext2D} ctx context to render on
+     */
+    _render(ctx: CanvasRenderingContext2D): void;
+    /**
+     * Returns horizontal radius of an object (according to how an object is scaled)
+     * @return {Number}
+     */
+    getRadiusX(): number;
+    /**
+     * Returns vertical radius of an object (according to how an object is scaled)
+     * @return {Number}
+     */
+    getRadiusY(): number;
+    /**
+     * Sets radius of an object (and updates width accordingly)
+     */
+    setRadius(value: number): 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(propertiesToInclude?: string[]): object;
+    /**
+     * Returns svg representation of an instance
+     * @return {Array} an array of strings with the specific svg representation
+     * of the instance
+     */
+    _toSVG(): (string | number)[];
+    /**
+     * List of attribute names to account for when parsing SVG element (used by {@link Circle.fromElement})
+     * @static
+     * @memberOf Circle
+     * @see: http://www.w3.org/TR/SVG/shapes.html#CircleElement
+     */
+    static ATTRIBUTE_NAMES: string[];
+    /**
+     * Returns {@link Circle} instance from an SVG element
+     * @static
+     * @memberOf Circle
+     * @param {SVGElement} element Element to parse
+     * @param {Function} [callback] Options callback invoked after parsing is finished
+     * @param {Object} [options] Partial Circle object to default missing properties on the element.
+     * @throws {Error} If value of `r` attribute is missing or invalid
+     */
+    static fromElement(element: SVGElement, callback: (circle: Circle) => any): void;
+}
+export declare const circleDefaultValues: Partial<TClassProperties<Circle>>;
+//# sourceMappingURL=Circle.d.ts.map

package/dist/src/shapes/Ellipse.d.ts

@@ -0,0 +1,74 @@
+import { TClassProperties } from '../typedefs';
+import { FabricObject } from './Object/FabricObject';
+export declare class Ellipse extends FabricObject {
+    /**
+     * Horizontal radius
+     * @type Number
+     * @default
+     */
+    rx: number;
+    /**
+     * Vertical radius
+     * @type Number
+     * @default
+     */
+    ry: number;
+    /**
+     * Constructor
+     * @param {Object} [options] Options object
+     * @return {Ellipse} thisArg
+     */
+    constructor(options: Record<string, unknown>);
+    /**
+     * @private
+     * @param {String} key
+     * @param {*} value
+     * @return {Ellipse} thisArg
+     */
+    _set(key: string, value: any): this;
+    /**
+     * Returns horizontal radius of an object (according to how an object is scaled)
+     * @return {Number}
+     */
+    getRx(): number;
+    /**
+     * Returns Vertical radius of an object (according to how an object is scaled)
+     * @return {Number}
+     */
+    getRy(): number;
+    /**
+     * 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(propertiesToInclude?: string[]): Record<string, any>;
+    /**
+     * Returns svg representation of an instance
+     * @return {Array} an array of strings with the specific svg representation
+     * of the instance
+     */
+    _toSVG(): (string | number)[];
+    /**
+     * @private
+     * @param {CanvasRenderingContext2D} ctx context to render on
+     */
+    _render(ctx: CanvasRenderingContext2D): void;
+    /**
+     * List of attribute names to account for when parsing SVG element (used by {@link Ellipse.fromElement})
+     * @static
+     * @memberOf Ellipse
+     * @see http://www.w3.org/TR/SVG/shapes.html#EllipseElement
+     */
+    static ATTRIBUTE_NAMES: string[];
+    /**
+     * Returns {@link Ellipse} instance from an SVG element
+     * @static
+     * @memberOf Ellipse
+     * @param {SVGElement} element Element to parse
+     * @param {Function} [callback] Options callback invoked after parsing is finished
+     * @return {Ellipse}
+     */
+    static fromElement(element: SVGElement, callback: (ellipse: Ellipse) => void): void;
+}
+export declare const ellipseDefaultValues: Partial<TClassProperties<Ellipse>>;
+//# sourceMappingURL=Ellipse.d.ts.map