fabric 5.3.0 → 6.0.0-beta10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (634) hide show
  1. package/.babelrc +11 -0
  2. package/.babelrcAlt +19 -0
  3. package/.browserslistrc +5 -0
  4. package/.eslintignore +3 -0
  5. package/.eslintrc.js +51 -0
  6. package/.eslintrc.json +38 -46
  7. package/.eslintrc_tests +12 -0
  8. package/.gitattributes +2 -0
  9. package/.gitpod.yml +17 -1
  10. package/.prettierignore +19 -0
  11. package/.prettierrc +4 -0
  12. package/CHANGELOG.md +615 -189
  13. package/CONTRIBUTING.md +233 -59
  14. package/README.md +200 -235
  15. package/babel-jest.config.js +6 -0
  16. package/bower.json +1 -3
  17. package/dist/fabric.d.ts +54 -0
  18. package/dist/index.d.ts +2 -0
  19. package/dist/index.js +28452 -0
  20. package/dist/index.js.map +1 -0
  21. package/dist/index.min.js +1 -0
  22. package/dist/index.mjs +28385 -0
  23. package/dist/index.mjs.map +1 -0
  24. package/dist/index.node.cjs +28538 -0
  25. package/dist/index.node.cjs.map +1 -0
  26. package/dist/index.node.d.ts +20 -0
  27. package/dist/index.node.mjs +28477 -0
  28. package/dist/index.node.mjs.map +1 -0
  29. package/dist/src/ClassRegistry.d.ts +13 -0
  30. package/dist/src/Collection.d.ts +136 -0
  31. package/dist/src/CommonMethods.d.ts +32 -0
  32. package/dist/src/EventTypeDefs.d.ts +227 -0
  33. package/dist/src/Intersection.d.ts +112 -0
  34. package/dist/src/Observable.d.ts +60 -0
  35. package/dist/src/Pattern/Pattern.d.ts +99 -0
  36. package/dist/src/Pattern/index.d.ts +3 -0
  37. package/dist/src/Pattern/types.d.ts +9 -0
  38. package/dist/src/Point.d.ts +232 -0
  39. package/dist/src/Shadow.d.ts +96 -0
  40. package/dist/src/brushes/BaseBrush.d.ts +101 -0
  41. package/dist/src/brushes/CircleBrush.d.ts +44 -0
  42. package/dist/src/brushes/CircleBrush.test.d.ts +2 -0
  43. package/dist/src/brushes/PatternBrush.d.ts +23 -0
  44. package/dist/src/brushes/PencilBrush.d.ts +92 -0
  45. package/dist/src/brushes/SprayBrush.d.ts +74 -0
  46. package/dist/src/brushes/typedefs.d.ts +18 -0
  47. package/dist/src/cache.d.ts +47 -0
  48. package/dist/src/canvas/Canvas.d.ts +364 -0
  49. package/dist/src/canvas/DOMManagers/CanvasDOMManager.d.ts +29 -0
  50. package/dist/src/canvas/DOMManagers/StaticCanvasDOMManager.d.ts +29 -0
  51. package/dist/src/canvas/DOMManagers/util.d.ts +24 -0
  52. package/dist/src/canvas/DOMManagers/util.spec.d.ts +2 -0
  53. package/dist/src/canvas/SelectableCanvas.d.ts +723 -0
  54. package/dist/src/canvas/StaticCanvas.d.ts +747 -0
  55. package/dist/src/canvas/TextEditingManager.d.ts +21 -0
  56. package/dist/src/canvas/canvas_gestures.mixin.d.ts +2 -0
  57. package/dist/src/color/Color.d.ts +152 -0
  58. package/dist/src/color/color_map.d.ts +155 -0
  59. package/dist/src/color/constants.d.ts +104 -0
  60. package/dist/src/color/typedefs.d.ts +16 -0
  61. package/dist/src/color/util.d.ts +27 -0
  62. package/dist/src/config.d.ts +115 -0
  63. package/dist/src/constants.d.ts +21 -0
  64. package/dist/src/controls/Control.d.ts +229 -0
  65. package/dist/src/controls/changeWidth.d.ts +13 -0
  66. package/dist/src/controls/commonControls.d.ts +28 -0
  67. package/dist/src/controls/controlRendering.d.ts +29 -0
  68. package/dist/src/controls/drag.d.ts +12 -0
  69. package/dist/src/controls/fireEvent.d.ts +3 -0
  70. package/dist/src/controls/index.d.ts +13 -0
  71. package/dist/src/controls/polyControl.d.ts +5 -0
  72. package/dist/src/controls/rotate.d.ts +12 -0
  73. package/dist/src/controls/scale.d.ts +47 -0
  74. package/dist/src/controls/scaleSkew.d.ts +39 -0
  75. package/dist/src/controls/skew.d.ts +33 -0
  76. package/dist/src/controls/util.d.ts +41 -0
  77. package/dist/src/controls/wrapWithFireEvent.d.ts +8 -0
  78. package/dist/src/controls/wrapWithFixedAnchor.d.ts +9 -0
  79. package/dist/src/env/browser.d.ts +3 -0
  80. package/dist/src/env/index.d.ts +28 -0
  81. package/dist/src/env/node.d.ts +6 -0
  82. package/dist/src/env/types.d.ts +15 -0
  83. package/dist/src/filters/BaseFilter.d.ts +160 -0
  84. package/dist/src/filters/BlendColor.d.ts +81 -0
  85. package/dist/src/filters/BlendImage.d.ts +93 -0
  86. package/dist/src/filters/Blur.d.ts +52 -0
  87. package/dist/src/filters/Boilerplate.d.ts +48 -0
  88. package/dist/src/filters/Brightness.d.ts +48 -0
  89. package/dist/src/filters/Canvas2dFilterBackend.d.ts +27 -0
  90. package/dist/src/filters/ColorMatrix.d.ts +64 -0
  91. package/dist/src/filters/ColorMatrixFilters.d.ts +537 -0
  92. package/dist/src/filters/Composed.d.ts +46 -0
  93. package/dist/src/filters/Contrast.d.ts +46 -0
  94. package/dist/src/filters/Convolute.d.ts +83 -0
  95. package/dist/src/filters/FilterBackend.d.ts +15 -0
  96. package/dist/src/filters/GLProbes/GLProbe.d.ts +7 -0
  97. package/dist/src/filters/GLProbes/NodeGLProbe.d.ts +11 -0
  98. package/dist/src/filters/GLProbes/WebGLProbe.d.ts +20 -0
  99. package/dist/src/filters/Gamma.d.ts +55 -0
  100. package/dist/src/filters/Grayscale.d.ts +47 -0
  101. package/dist/src/filters/HueRotation.d.ts +25 -0
  102. package/dist/src/filters/Invert.d.ts +56 -0
  103. package/dist/src/filters/Noise.d.ts +55 -0
  104. package/dist/src/filters/Pixelate.d.ts +45 -0
  105. package/dist/src/filters/RemoveColor.d.ts +64 -0
  106. package/dist/src/filters/Resize.d.ts +137 -0
  107. package/dist/src/filters/Saturation.d.ts +49 -0
  108. package/dist/src/filters/Vibrance.d.ts +49 -0
  109. package/dist/src/filters/WebGLFilterBackend.d.ts +128 -0
  110. package/dist/src/filters/filters.d.ts +21 -0
  111. package/dist/src/filters/index.d.ts +7 -0
  112. package/dist/src/filters/shaders/baseFilter.d.ts +4 -0
  113. package/dist/src/filters/shaders/blendColor.d.ts +13 -0
  114. package/dist/src/filters/shaders/blendImage.d.ts +3 -0
  115. package/dist/src/filters/shaders/blur.d.ts +2 -0
  116. package/dist/src/filters/shaders/brightness.d.ts +2 -0
  117. package/dist/src/filters/shaders/colorMatrix.d.ts +2 -0
  118. package/dist/src/filters/shaders/constrast.d.ts +2 -0
  119. package/dist/src/filters/shaders/convolute.d.ts +11 -0
  120. package/dist/src/filters/shaders/gamma.d.ts +2 -0
  121. package/dist/src/filters/shaders/grayscale.d.ts +3 -0
  122. package/dist/src/filters/shaders/invert.d.ts +2 -0
  123. package/dist/src/filters/shaders/noise.d.ts +2 -0
  124. package/dist/src/filters/shaders/pixelate.d.ts +2 -0
  125. package/dist/src/filters/shaders/removeColor.d.ts +2 -0
  126. package/dist/src/filters/shaders/saturation.d.ts +2 -0
  127. package/dist/src/filters/shaders/vibrance.d.ts +2 -0
  128. package/dist/src/filters/typedefs.d.ts +48 -0
  129. package/dist/src/filters/utils.d.ts +3 -0
  130. package/dist/src/gradient/Gradient.d.ts +150 -0
  131. package/dist/src/gradient/constants.d.ts +15 -0
  132. package/dist/src/gradient/index.d.ts +3 -0
  133. package/dist/src/gradient/parser/index.d.ts +4 -0
  134. package/dist/src/gradient/parser/misc.d.ts +4 -0
  135. package/dist/src/gradient/parser/parseColorStops.d.ts +3 -0
  136. package/dist/src/gradient/parser/parseCoords.d.ts +17 -0
  137. package/dist/src/gradient/typedefs.d.ts +93 -0
  138. package/dist/src/mixins/eraser_brush.mixin.d.ts +2 -0
  139. package/dist/src/parkinglot/canvas_animation.mixin.d.ts +2 -0
  140. package/dist/src/parkinglot/straighten.d.ts +2 -0
  141. package/dist/src/parser/applyViewboxTransform.d.ts +5 -0
  142. package/dist/src/parser/attributes.d.ts +6 -0
  143. package/dist/src/parser/constants.d.ts +53 -0
  144. package/dist/src/parser/doesSomeParentMatch.d.ts +2 -0
  145. package/dist/src/parser/elementById.d.ts +6 -0
  146. package/dist/src/parser/elementMatchesRule.d.ts +5 -0
  147. package/dist/src/parser/elements_parser.d.ts +3 -0
  148. package/dist/src/parser/getCSSRules.d.ts +7 -0
  149. package/dist/src/parser/getGlobalStylesForElement.d.ts +5 -0
  150. package/dist/src/parser/getGradientDefs.d.ts +7 -0
  151. package/dist/src/parser/getMultipleNodes.d.ts +2 -0
  152. package/dist/src/parser/getSvgRegex.d.ts +2 -0
  153. package/dist/src/parser/hasAncestorWithNodeName.d.ts +2 -0
  154. package/dist/src/parser/index.d.ts +9 -0
  155. package/dist/src/parser/loadSVGFromString.d.ts +18 -0
  156. package/dist/src/parser/loadSVGFromURL.d.ts +19 -0
  157. package/dist/src/parser/normalizeAttr.d.ts +2 -0
  158. package/dist/src/parser/normalizeValue.d.ts +2 -0
  159. package/dist/src/parser/parseAttributes.d.ts +9 -0
  160. package/dist/src/parser/parseFontDeclaration.d.ts +10 -0
  161. package/dist/src/parser/parsePointsAttribute.d.ts +12 -0
  162. package/dist/src/parser/parseSVGDocument.d.ts +23 -0
  163. package/dist/src/parser/parseStyleAttribute.d.ts +9 -0
  164. package/dist/src/parser/parseStyleObject.d.ts +2 -0
  165. package/dist/src/parser/parseStyleString.d.ts +2 -0
  166. package/dist/src/parser/parseTransformAttribute.d.ts +11 -0
  167. package/dist/src/parser/parseUseDirectives.d.ts +2 -0
  168. package/dist/src/parser/percent.d.ts +9 -0
  169. package/dist/src/parser/recursivelyParseGradientsXlink.d.ts +2 -0
  170. package/dist/src/parser/selectorMatches.d.ts +2 -0
  171. package/dist/src/parser/setStrokeFillOpacity.d.ts +6 -0
  172. package/dist/src/parser/typedefs.d.ts +9 -0
  173. package/dist/src/shapes/ActiveSelection.d.ts +83 -0
  174. package/dist/src/shapes/Circle.d.ts +99 -0
  175. package/dist/src/shapes/Ellipse.d.ts +84 -0
  176. package/dist/src/shapes/Group.d.ts +407 -0
  177. package/dist/src/shapes/IText/DraggableTextDelegate.d.ts +78 -0
  178. package/dist/src/shapes/IText/IText.d.ts +336 -0
  179. package/dist/src/shapes/IText/ITextBehavior.d.ts +287 -0
  180. package/dist/src/shapes/IText/ITextClickBehavior.d.ts +73 -0
  181. package/dist/src/shapes/IText/ITextKeyBehavior.d.ts +195 -0
  182. package/dist/src/shapes/IText/constants.d.ts +13 -0
  183. package/dist/src/shapes/Image.d.ts +309 -0
  184. package/dist/src/shapes/Line.d.ts +121 -0
  185. package/dist/src/shapes/Object/AnimatableObject.d.ts +33 -0
  186. package/dist/src/shapes/Object/FabricObject.d.ts +11 -0
  187. package/dist/src/shapes/Object/FabricObjectSVGExportMixin.d.ts +74 -0
  188. package/dist/src/shapes/Object/InteractiveObject.d.ts +296 -0
  189. package/dist/src/shapes/Object/Object.d.ts +599 -0
  190. package/dist/src/shapes/Object/ObjectGeometry.d.ts +327 -0
  191. package/dist/src/shapes/Object/ObjectOrigin.d.ts +109 -0
  192. package/dist/src/shapes/Object/StackedObject.d.ts +72 -0
  193. package/dist/src/shapes/Object/defaultValues.d.ts +76 -0
  194. package/dist/src/shapes/Object/types/BaseProps.d.ts +84 -0
  195. package/dist/src/shapes/Object/types/BorderProps.d.ts +37 -0
  196. package/dist/src/shapes/Object/types/ControlProps.d.ts +62 -0
  197. package/dist/src/shapes/Object/types/FabricObjectProps.d.ts +96 -0
  198. package/dist/src/shapes/Object/types/FillStrokeProps.d.ts +80 -0
  199. package/dist/src/shapes/Object/types/LockInteractionProps.d.ts +51 -0
  200. package/dist/src/shapes/Object/types/ObjectProps.d.ts +42 -0
  201. package/dist/src/shapes/Object/types/SerializedObjectProps.d.ts +66 -0
  202. package/dist/src/shapes/Object/types/index.d.ts +6 -0
  203. package/dist/src/shapes/Path.d.ts +214 -0
  204. package/dist/src/shapes/Polygon.d.ts +10 -0
  205. package/dist/src/shapes/Polyline.d.ts +147 -0
  206. package/dist/src/shapes/Rect.d.ts +82 -0
  207. package/dist/src/shapes/Text/StyledText.d.ts +123 -0
  208. package/dist/src/shapes/Text/Text.d.ts +688 -0
  209. package/dist/src/shapes/Text/TextSVGExportMixin.d.ts +32 -0
  210. package/dist/src/shapes/Text/constants.d.ts +13 -0
  211. package/dist/src/shapes/Textbox.d.ts +204 -0
  212. package/dist/src/shapes/Triangle.d.ts +26 -0
  213. package/dist/src/typedefs.d.ts +96 -0
  214. package/dist/src/util/animation/AnimationBase.d.ts +54 -0
  215. package/dist/src/util/animation/AnimationFrameProvider.d.ts +3 -0
  216. package/dist/src/util/animation/AnimationRegistry.d.ts +29 -0
  217. package/dist/src/util/animation/ArrayAnimation.d.ts +10 -0
  218. package/dist/src/util/animation/ColorAnimation.d.ts +11 -0
  219. package/dist/src/util/animation/ValueAnimation.d.ts +10 -0
  220. package/dist/src/util/animation/animate.d.ts +37 -0
  221. package/dist/src/util/animation/easing.d.ts +130 -0
  222. package/dist/src/util/animation/index.d.ts +3 -0
  223. package/dist/src/util/animation/types.d.ts +87 -0
  224. package/dist/src/util/applyMixins.d.ts +8 -0
  225. package/dist/src/util/dom_event.d.ts +5 -0
  226. package/dist/src/util/dom_misc.d.ts +12 -0
  227. package/dist/src/util/dom_request.d.ts +14 -0
  228. package/dist/src/util/dom_style.d.ts +7 -0
  229. package/dist/src/util/index.d.ts +36 -0
  230. package/dist/src/util/internals/cleanupSvgAttribute.d.ts +2 -0
  231. package/dist/src/util/internals/cleanupSvgAttribute.test.d.ts +2 -0
  232. package/dist/src/util/internals/cloneDeep.d.ts +2 -0
  233. package/dist/src/util/internals/cloneDeep.test.d.ts +2 -0
  234. package/dist/src/util/internals/getRandomInt.d.ts +8 -0
  235. package/dist/src/util/internals/getRandomInt.test.d.ts +2 -0
  236. package/dist/src/util/internals/ifNaN.d.ts +8 -0
  237. package/dist/src/util/internals/index.d.ts +4 -0
  238. package/dist/src/util/internals/removeFromArray.d.ts +9 -0
  239. package/dist/src/util/internals/uid.d.ts +2 -0
  240. package/dist/src/util/lang_string.d.ts +22 -0
  241. package/dist/src/util/misc/boundingBoxFromPoints.d.ts +9 -0
  242. package/dist/src/util/misc/capValue.d.ts +2 -0
  243. package/dist/src/util/misc/cos.d.ts +10 -0
  244. package/dist/src/util/misc/dom.d.ts +28 -0
  245. package/dist/src/util/misc/findScaleTo.d.ts +20 -0
  246. package/dist/src/util/misc/groupSVGElements.d.ts +9 -0
  247. package/dist/src/util/misc/isTransparent.d.ts +11 -0
  248. package/dist/src/util/misc/matrix.d.ts +168 -0
  249. package/dist/src/util/misc/mergeClipPaths.d.ts +23 -0
  250. package/dist/src/util/misc/objectEnlive.d.ts +41 -0
  251. package/dist/src/util/misc/objectTransforms.d.ts +68 -0
  252. package/dist/src/util/misc/pick.d.ts +9 -0
  253. package/dist/src/util/misc/planeChange.d.ts +81 -0
  254. package/dist/src/util/misc/projectStroke/StrokeLineCapProjections.d.ts +52 -0
  255. package/dist/src/util/misc/projectStroke/StrokeLineJoinProjections.d.ts +82 -0
  256. package/dist/src/util/misc/projectStroke/StrokeProjectionsBase.d.ts +26 -0
  257. package/dist/src/util/misc/projectStroke/index.d.ts +12 -0
  258. package/dist/src/util/misc/projectStroke/types.d.ts +23 -0
  259. package/dist/src/util/misc/radiansDegreesConversion.d.ts +14 -0
  260. package/dist/src/util/misc/resolveOrigin.d.ts +9 -0
  261. package/dist/src/util/misc/rotatePoint.d.ts +12 -0
  262. package/dist/src/util/misc/sin.d.ts +10 -0
  263. package/dist/src/util/misc/svgParsing.d.ts +45 -0
  264. package/dist/src/util/misc/textStyles.d.ts +32 -0
  265. package/dist/src/util/misc/toFixed.d.ts +8 -0
  266. package/dist/src/util/misc/vectors.d.ts +58 -0
  267. package/dist/src/util/path/index.d.ts +96 -0
  268. package/dist/src/util/path/regex.d.ts +2 -0
  269. package/dist/src/util/path/typechecks.d.ts +24 -0
  270. package/dist/src/util/path/typedefs.d.ts +220 -0
  271. package/dist/src/util/transform_matrix_removal.d.ts +14 -0
  272. package/dist/src/util/typeAssertions.d.ts +19 -0
  273. package/e2e/site/index.html +25 -0
  274. package/e2e/utils/objects.ts +36 -0
  275. package/fabric.ts +72 -0
  276. package/index.node.ts +43 -0
  277. package/index.ts +1 -0
  278. package/jest.config.js +194 -0
  279. package/lib/aligning_guidelines.js +2 -2
  280. package/package.json +110 -40
  281. package/playwright.config.ts +64 -0
  282. package/publish.js +0 -26
  283. package/rollup.config.mjs +99 -0
  284. package/rollup.test.config.js +24 -0
  285. package/scripts/build.mjs +50 -0
  286. package/scripts/buildLock.mjs +115 -0
  287. package/scripts/buildReporter.mjs +15 -0
  288. package/scripts/buildStats.mjs +139 -0
  289. package/scripts/dirname.mjs +14 -0
  290. package/scripts/git.mjs +36 -0
  291. package/scripts/index.mjs +564 -0
  292. package/scripts/sandbox.mjs +149 -0
  293. package/src/ClassRegistry.ts +56 -0
  294. package/src/Collection.ts +346 -0
  295. package/src/CommonMethods.ts +63 -0
  296. package/src/EventTypeDefs.ts +298 -0
  297. package/src/Intersection.ts +302 -0
  298. package/src/Observable.ts +181 -0
  299. package/src/Pattern/Pattern.ts +207 -0
  300. package/src/Pattern/index.ts +2 -0
  301. package/src/Pattern/types.ts +17 -0
  302. package/src/Point.ts +388 -0
  303. package/src/Shadow.ts +214 -0
  304. package/src/brushes/{base_brush.class.js → BaseBrush.ts} +63 -42
  305. package/src/brushes/CircleBrush.test.ts +11 -0
  306. package/src/brushes/CircleBrush.ts +140 -0
  307. package/src/brushes/PatternBrush.ts +70 -0
  308. package/src/brushes/PencilBrush.ts +300 -0
  309. package/src/brushes/SprayBrush.ts +214 -0
  310. package/src/brushes/typedefs.ts +18 -0
  311. package/src/cache.ts +90 -0
  312. package/src/canvas/Canvas.ts +1598 -0
  313. package/src/canvas/DOMManagers/CanvasDOMManager.ts +124 -0
  314. package/src/canvas/DOMManagers/StaticCanvasDOMManager.ts +80 -0
  315. package/src/canvas/DOMManagers/util.spec.ts +26 -0
  316. package/src/canvas/DOMManagers/util.ts +98 -0
  317. package/src/canvas/SelectableCanvas.ts +1506 -0
  318. package/src/canvas/StaticCanvas.ts +1634 -0
  319. package/src/canvas/TextEditingManager.ts +70 -0
  320. package/src/canvas/canvas_gestures.mixin.ts +207 -0
  321. package/src/color/Color.ts +320 -0
  322. package/src/color/color_map.ts +154 -0
  323. package/src/color/constants.ts +107 -0
  324. package/src/color/typedefs.ts +18 -0
  325. package/src/color/util.ts +93 -0
  326. package/src/config.ts +159 -0
  327. package/src/constants.ts +29 -0
  328. package/src/controls/Control.ts +385 -0
  329. package/src/controls/changeWidth.ts +53 -0
  330. package/src/controls/commonControls.ts +105 -0
  331. package/src/controls/controlRendering.ts +138 -0
  332. package/src/controls/drag.ts +32 -0
  333. package/src/controls/fireEvent.ts +18 -0
  334. package/src/controls/index.ts +22 -0
  335. package/src/controls/polyControl.ts +135 -0
  336. package/src/controls/rotate.ts +87 -0
  337. package/src/controls/scale.ts +277 -0
  338. package/src/controls/scaleSkew.ts +92 -0
  339. package/src/controls/skew.ts +243 -0
  340. package/src/controls/util.ts +155 -0
  341. package/src/controls/wrapWithFireEvent.ts +25 -0
  342. package/src/controls/wrapWithFixedAnchor.ts +20 -0
  343. package/src/env/browser.ts +32 -0
  344. package/src/env/index.ts +38 -0
  345. package/src/env/node.ts +58 -0
  346. package/src/env/types.ts +15 -0
  347. package/src/filters/{base_filter.class.js → BaseFilter.ts} +203 -151
  348. package/src/filters/BlendColor.ts +219 -0
  349. package/src/filters/BlendImage.ts +230 -0
  350. package/src/filters/Blur.ts +181 -0
  351. package/src/filters/Boilerplate.ts +94 -0
  352. package/src/filters/Brightness.ts +85 -0
  353. package/src/filters/Canvas2dFilterBackend.ts +65 -0
  354. package/src/filters/ColorMatrix.ts +147 -0
  355. package/src/filters/ColorMatrixFilters.ts +79 -0
  356. package/src/filters/Composed.ts +78 -0
  357. package/src/filters/Contrast.ts +84 -0
  358. package/src/filters/Convolute.ts +186 -0
  359. package/src/filters/FilterBackend.ts +38 -0
  360. package/src/filters/GLProbes/GLProbe.ts +7 -0
  361. package/src/filters/GLProbes/NodeGLProbe.ts +15 -0
  362. package/src/filters/GLProbes/WebGLProbe.ts +47 -0
  363. package/src/filters/Gamma.ts +112 -0
  364. package/src/filters/Grayscale.ts +104 -0
  365. package/src/filters/HueRotation.ts +64 -0
  366. package/src/filters/Invert.ts +101 -0
  367. package/src/filters/Noise.ts +96 -0
  368. package/src/filters/Pixelate.ts +98 -0
  369. package/src/filters/RemoveColor.ts +137 -0
  370. package/src/filters/Resize.ts +540 -0
  371. package/src/filters/Saturation.ts +89 -0
  372. package/src/filters/Vibrance.ts +90 -0
  373. package/src/filters/WebGLFilterBackend.ts +456 -0
  374. package/src/filters/filters.ts +28 -0
  375. package/src/filters/index.ts +12 -0
  376. package/src/filters/shaders/baseFilter.ts +17 -0
  377. package/src/filters/shaders/blendColor.ts +33 -0
  378. package/src/filters/shaders/blendImage.ts +32 -0
  379. package/src/filters/shaders/blur.ts +24 -0
  380. package/src/filters/shaders/brightness.ts +11 -0
  381. package/src/filters/shaders/colorMatrix.ts +12 -0
  382. package/src/filters/shaders/constrast.ts +11 -0
  383. package/src/filters/shaders/convolute.ts +154 -0
  384. package/src/filters/shaders/gamma.ts +15 -0
  385. package/src/filters/shaders/grayscale.ts +36 -0
  386. package/src/filters/shaders/invert.ts +19 -0
  387. package/src/filters/shaders/noise.ts +16 -0
  388. package/src/filters/shaders/pixelate.ts +19 -0
  389. package/src/filters/shaders/removeColor.ts +13 -0
  390. package/src/filters/shaders/saturation.ts +15 -0
  391. package/src/filters/shaders/vibrance.ts +16 -0
  392. package/src/filters/typedefs.ts +59 -0
  393. package/src/filters/utils.ts +7 -0
  394. package/src/gradient/Gradient.ts +409 -0
  395. package/src/gradient/constants.ts +12 -0
  396. package/src/gradient/index.ts +2 -0
  397. package/src/gradient/parser/index.ts +3 -0
  398. package/src/gradient/parser/misc.ts +13 -0
  399. package/src/gradient/parser/parseColorStops.ts +56 -0
  400. package/src/gradient/parser/parseCoords.ts +73 -0
  401. package/src/gradient/typedefs.ts +104 -0
  402. package/src/mixins/{eraser_brush.mixin.js → eraser_brush.mixin.ts} +350 -239
  403. package/src/parkinglot/canvas_animation.mixin.ts +121 -0
  404. package/src/parkinglot/straighten.ts +58 -0
  405. package/src/parser/applyViewboxTransform.ts +158 -0
  406. package/src/parser/attributes.ts +25 -0
  407. package/src/parser/constants.ts +116 -0
  408. package/src/parser/doesSomeParentMatch.ts +18 -0
  409. package/src/parser/elementById.ts +21 -0
  410. package/src/parser/elementMatchesRule.ts +16 -0
  411. package/src/parser/elements_parser.ts +158 -0
  412. package/src/parser/getCSSRules.ts +61 -0
  413. package/src/parser/getGlobalStylesForElement.ts +19 -0
  414. package/src/parser/getGradientDefs.ts +31 -0
  415. package/src/parser/getMultipleNodes.ts +15 -0
  416. package/src/parser/getSvgRegex.ts +3 -0
  417. package/src/parser/hasAncestorWithNodeName.ts +14 -0
  418. package/src/parser/index.ts +8 -0
  419. package/src/parser/loadSVGFromString.ts +29 -0
  420. package/src/parser/loadSVGFromURL.ts +47 -0
  421. package/src/parser/normalizeAttr.ts +10 -0
  422. package/src/parser/normalizeValue.ts +64 -0
  423. package/src/parser/parseAttributes.ts +90 -0
  424. package/src/parser/parseFontDeclaration.ts +44 -0
  425. package/src/parser/parsePointsAttribute.ts +34 -0
  426. package/src/parser/parseSVGDocument.ts +118 -0
  427. package/src/parser/parseStyleAttribute.ts +27 -0
  428. package/src/parser/parseStyleObject.ts +15 -0
  429. package/src/parser/parseStyleString.ts +16 -0
  430. package/src/parser/parseTransformAttribute.ts +94 -0
  431. package/src/parser/parseUseDirectives.ts +78 -0
  432. package/src/parser/percent.ts +27 -0
  433. package/src/parser/recursivelyParseGradientsXlink.ts +42 -0
  434. package/src/parser/selectorMatches.ts +25 -0
  435. package/src/parser/setStrokeFillOpacity.ts +40 -0
  436. package/src/parser/typedefs.ts +13 -0
  437. package/src/shapes/ActiveSelection.ts +192 -0
  438. package/src/shapes/Circle.ts +236 -0
  439. package/src/shapes/Ellipse.ts +177 -0
  440. package/src/shapes/Group.ts +1103 -0
  441. package/src/shapes/IText/DraggableTextDelegate.ts +385 -0
  442. package/src/shapes/IText/IText.ts +696 -0
  443. package/src/shapes/IText/ITextBehavior.ts +1073 -0
  444. package/src/shapes/IText/ITextClickBehavior.ts +292 -0
  445. package/src/shapes/IText/ITextKeyBehavior.ts +675 -0
  446. package/src/shapes/IText/constants.ts +53 -0
  447. package/src/shapes/Image.ts +848 -0
  448. package/src/shapes/Line.ts +285 -0
  449. package/src/shapes/Object/AnimatableObject.ts +103 -0
  450. package/src/shapes/Object/FabricObject.ts +29 -0
  451. package/src/shapes/Object/FabricObjectSVGExportMixin.ts +278 -0
  452. package/src/shapes/Object/InteractiveObject.ts +669 -0
  453. package/src/shapes/Object/Object.ts +1589 -0
  454. package/src/shapes/Object/ObjectGeometry.ts +814 -0
  455. package/src/shapes/Object/ObjectOrigin.ts +277 -0
  456. package/src/shapes/Object/StackedObject.ts +206 -0
  457. package/src/shapes/Object/defaultValues.ts +110 -0
  458. package/src/shapes/Object/types/BaseProps.ts +96 -0
  459. package/src/shapes/Object/types/BorderProps.ts +40 -0
  460. package/src/shapes/Object/types/ControlProps.ts +69 -0
  461. package/src/shapes/Object/types/FabricObjectProps.ts +111 -0
  462. package/src/shapes/Object/types/FillStrokeProps.ts +90 -0
  463. package/src/shapes/Object/types/LockInteractionProps.ts +57 -0
  464. package/src/shapes/Object/types/ObjectProps.ts +49 -0
  465. package/src/shapes/Object/types/SerializedObjectProps.ts +73 -0
  466. package/src/shapes/Object/types/index.ts +8 -0
  467. package/src/shapes/Path.ts +434 -0
  468. package/src/shapes/Polygon.ts +22 -0
  469. package/src/shapes/Polyline.ts +364 -0
  470. package/src/shapes/Rect.ts +230 -0
  471. package/src/shapes/Text/StyledText.ts +323 -0
  472. package/src/shapes/Text/Text.ts +1891 -0
  473. package/src/shapes/Text/TextSVGExportMixin.ts +289 -0
  474. package/src/shapes/Text/constants.ts +111 -0
  475. package/src/shapes/Textbox.ts +526 -0
  476. package/src/shapes/Triangle.ts +62 -0
  477. package/src/typedefs.ts +121 -0
  478. package/src/util/animation/AnimationBase.ts +166 -0
  479. package/src/util/animation/AnimationFrameProvider.ts +9 -0
  480. package/src/util/animation/AnimationRegistry.ts +58 -0
  481. package/src/util/animation/ArrayAnimation.ts +27 -0
  482. package/src/util/animation/ColorAnimation.ts +74 -0
  483. package/src/util/animation/ValueAnimation.ts +29 -0
  484. package/src/util/animation/animate.ts +74 -0
  485. package/src/util/animation/easing.ts +327 -0
  486. package/src/util/animation/index.ts +2 -0
  487. package/src/util/animation/types.ts +136 -0
  488. package/src/util/applyMixins.ts +22 -0
  489. package/src/util/dom_event.ts +28 -0
  490. package/src/util/dom_misc.ts +44 -0
  491. package/src/util/dom_request.ts +64 -0
  492. package/src/util/dom_style.ts +20 -0
  493. package/src/util/index.ts +106 -0
  494. package/src/util/internals/cleanupSvgAttribute.test.ts +16 -0
  495. package/src/util/internals/cleanupSvgAttribute.ts +8 -0
  496. package/src/util/internals/cloneDeep.test.ts +16 -0
  497. package/src/util/internals/cloneDeep.ts +2 -0
  498. package/src/util/internals/getRandomInt.test.ts +33 -0
  499. package/src/util/internals/getRandomInt.ts +8 -0
  500. package/src/util/internals/ifNaN.ts +9 -0
  501. package/src/util/internals/index.ts +3 -0
  502. package/src/util/internals/removeFromArray.ts +14 -0
  503. package/src/util/internals/uid.ts +3 -0
  504. package/src/util/lang_string.ts +79 -0
  505. package/src/util/misc/boundingBoxFromPoints.ts +38 -0
  506. package/src/util/misc/capValue.ts +2 -0
  507. package/src/util/misc/cos.ts +24 -0
  508. package/src/util/misc/dom.ts +55 -0
  509. package/src/util/misc/findScaleTo.ts +29 -0
  510. package/src/util/misc/groupSVGElements.ts +15 -0
  511. package/src/util/misc/isTransparent.ts +28 -0
  512. package/src/util/misc/matrix.ts +313 -0
  513. package/src/util/misc/mergeClipPaths.ts +40 -0
  514. package/src/util/misc/objectEnlive.ts +174 -0
  515. package/src/util/misc/objectTransforms.ts +130 -0
  516. package/src/util/misc/pick.ts +29 -0
  517. package/src/util/misc/planeChange.ts +127 -0
  518. package/src/util/misc/projectStroke/StrokeLineCapProjections.ts +113 -0
  519. package/src/util/misc/projectStroke/StrokeLineJoinProjections.ts +227 -0
  520. package/src/util/misc/projectStroke/StrokeProjectionsBase.ts +76 -0
  521. package/src/util/misc/projectStroke/index.ts +55 -0
  522. package/src/util/misc/projectStroke/types.ts +24 -0
  523. package/src/util/misc/radiansDegreesConversion.ts +18 -0
  524. package/src/util/misc/resolveOrigin.ts +22 -0
  525. package/src/util/misc/rotatePoint.ts +15 -0
  526. package/src/util/misc/sin.ts +26 -0
  527. package/src/util/misc/svgParsing.ts +171 -0
  528. package/src/util/misc/textStyles.ts +132 -0
  529. package/src/util/misc/toFixed.ts +8 -0
  530. package/src/util/misc/vectors.ts +83 -0
  531. package/src/util/path/index.ts +1039 -0
  532. package/src/util/path/regex.ts +39 -0
  533. package/src/util/path/typechecks.ts +145 -0
  534. package/src/util/path/typedefs.ts +305 -0
  535. package/src/util/transform_matrix_removal.ts +61 -0
  536. package/src/util/typeAssertions.ts +78 -0
  537. package/tsconfig.json +106 -0
  538. package/HEADER.js +0 -203
  539. package/build.js +0 -287
  540. package/dist/fabric.js +0 -31187
  541. package/dist/fabric.min.js +0 -1
  542. package/old-travis-reference.yml +0 -97
  543. package/src/brushes/circle_brush.class.js +0 -144
  544. package/src/brushes/pattern_brush.class.js +0 -61
  545. package/src/brushes/pencil_brush.class.js +0 -310
  546. package/src/brushes/spray_brush.class.js +0 -219
  547. package/src/canvas.class.js +0 -1312
  548. package/src/color.class.js +0 -636
  549. package/src/control.class.js +0 -339
  550. package/src/controls.actions.js +0 -740
  551. package/src/controls.render.js +0 -99
  552. package/src/elements_parser.js +0 -152
  553. package/src/filters/2d_backend.class.js +0 -65
  554. package/src/filters/blendcolor_filter.class.js +0 -251
  555. package/src/filters/blendimage_filter.class.js +0 -247
  556. package/src/filters/blur_filter.class.js +0 -217
  557. package/src/filters/brightness_filter.class.js +0 -113
  558. package/src/filters/colormatrix_filter.class.js +0 -159
  559. package/src/filters/composed_filter.class.js +0 -72
  560. package/src/filters/contrast_filter.class.js +0 -113
  561. package/src/filters/convolute_filter.class.js +0 -352
  562. package/src/filters/filter_boilerplate.js +0 -111
  563. package/src/filters/filter_generator.js +0 -85
  564. package/src/filters/gamma_filter.class.js +0 -136
  565. package/src/filters/grayscale_filter.class.js +0 -154
  566. package/src/filters/hue_rotation.class.js +0 -107
  567. package/src/filters/invert_filter.class.js +0 -111
  568. package/src/filters/noise_filter.class.js +0 -134
  569. package/src/filters/pixelate_filter.class.js +0 -137
  570. package/src/filters/removecolor_filter.class.js +0 -173
  571. package/src/filters/resize_filter.class.js +0 -490
  572. package/src/filters/saturate_filter.class.js +0 -119
  573. package/src/filters/vibrance_filter.class.js +0 -122
  574. package/src/filters/webgl_backend.class.js +0 -396
  575. package/src/globalFabric.js +0 -4
  576. package/src/gradient.class.js +0 -490
  577. package/src/intersection.class.js +0 -172
  578. package/src/log.js +0 -11
  579. package/src/mixins/animation.mixin.js +0 -231
  580. package/src/mixins/canvas_dataurl_exporter.mixin.js +0 -97
  581. package/src/mixins/canvas_events.mixin.js +0 -974
  582. package/src/mixins/canvas_gestures.mixin.js +0 -149
  583. package/src/mixins/canvas_grouping.mixin.js +0 -177
  584. package/src/mixins/canvas_serialization.mixin.js +0 -228
  585. package/src/mixins/collection.mixin.js +0 -170
  586. package/src/mixins/default_controls.js +0 -114
  587. package/src/mixins/itext.svg_export.js +0 -241
  588. package/src/mixins/itext_behavior.mixin.js +0 -940
  589. package/src/mixins/itext_click_behavior.mixin.js +0 -278
  590. package/src/mixins/itext_key_behavior.mixin.js +0 -694
  591. package/src/mixins/object.svg_export.js +0 -258
  592. package/src/mixins/object_geometry.mixin.js +0 -683
  593. package/src/mixins/object_interactivity.mixin.js +0 -314
  594. package/src/mixins/object_origin.mixin.js +0 -255
  595. package/src/mixins/object_stacking.mixin.js +0 -80
  596. package/src/mixins/object_straightening.mixin.js +0 -80
  597. package/src/mixins/observable.mixin.js +0 -141
  598. package/src/mixins/shared_methods.mixin.js +0 -94
  599. package/src/mixins/stateful.mixin.js +0 -107
  600. package/src/mixins/text_style.mixin.js +0 -324
  601. package/src/parser.js +0 -1090
  602. package/src/pattern.class.js +0 -189
  603. package/src/point.class.js +0 -337
  604. package/src/shadow.class.js +0 -195
  605. package/src/shapes/active_selection.class.js +0 -155
  606. package/src/shapes/circle.class.js +0 -210
  607. package/src/shapes/ellipse.class.js +0 -181
  608. package/src/shapes/group.class.js +0 -593
  609. package/src/shapes/image.class.js +0 -764
  610. package/src/shapes/itext.class.js +0 -526
  611. package/src/shapes/line.class.js +0 -324
  612. package/src/shapes/object.class.js +0 -2008
  613. package/src/shapes/path.class.js +0 -384
  614. package/src/shapes/polygon.class.js +0 -81
  615. package/src/shapes/polyline.class.js +0 -268
  616. package/src/shapes/rect.class.js +0 -187
  617. package/src/shapes/text.class.js +0 -1696
  618. package/src/shapes/textbox.class.js +0 -461
  619. package/src/shapes/triangle.class.js +0 -93
  620. package/src/static_canvas.class.js +0 -1881
  621. package/src/util/anim_ease.js +0 -398
  622. package/src/util/animate.js +0 -254
  623. package/src/util/animate_color.js +0 -74
  624. package/src/util/dom_event.js +0 -50
  625. package/src/util/dom_misc.js +0 -300
  626. package/src/util/dom_request.js +0 -54
  627. package/src/util/dom_style.js +0 -70
  628. package/src/util/lang_array.js +0 -94
  629. package/src/util/lang_class.js +0 -115
  630. package/src/util/lang_object.js +0 -75
  631. package/src/util/lang_string.js +0 -110
  632. package/src/util/misc.js +0 -1330
  633. package/src/util/named_accessors.mixin.js +0 -428
  634. package/src/util/path.js +0 -829
@@ -0,0 +1,747 @@
1
+ import type { CanvasEvents, StaticCanvasEvents } from '../EventTypeDefs';
2
+ import { CommonMethods } from '../CommonMethods';
3
+ import { Point } from '../Point';
4
+ import type { BaseFabricObject as FabricObject } from '../EventTypeDefs';
5
+ import type { TCachedFabricObject } from '../shapes/Object/Object';
6
+ import type { Abortable, TCornerPoint, TDataUrlOptions, TFiller, TMat2D, TSize, TSVGReviver, TToCanvasElementOptions, TValidToObjectMethod } from '../typedefs';
7
+ import type { EnlivenObjectOptions } from '../util/misc/objectEnlive';
8
+ import { StaticCanvasDOMManager } from './DOMManagers/StaticCanvasDOMManager';
9
+ import type { CSSDimensions } from './DOMManagers/util';
10
+ export type TCanvasSizeOptions = {
11
+ backstoreOnly?: boolean;
12
+ cssOnly?: boolean;
13
+ };
14
+ export type TSVGExportOptions = {
15
+ suppressPreamble?: boolean;
16
+ viewBox?: {
17
+ x: number;
18
+ y: number;
19
+ width: number;
20
+ height: number;
21
+ };
22
+ encoding?: 'UTF-8';
23
+ width?: string;
24
+ height?: string;
25
+ reviver?: TSVGReviver;
26
+ };
27
+ export declare const StaticCanvasDefaults: {
28
+ backgroundColor: string;
29
+ backgroundImage: null;
30
+ overlayColor: string;
31
+ overlayImage: null;
32
+ includeDefaultValues: boolean;
33
+ renderOnAddRemove: boolean;
34
+ controlsAboveOverlay: boolean;
35
+ allowTouchScrolling: boolean;
36
+ imageSmoothingEnabled: boolean;
37
+ viewportTransform: number[];
38
+ backgroundVpt: boolean;
39
+ overlayVpt: boolean;
40
+ enableRetinaScaling: boolean;
41
+ svgViewportTransformation: boolean;
42
+ skipOffscreen: boolean;
43
+ clipPath: undefined;
44
+ };
45
+ declare const StaticCanvas_base: {
46
+ new (...args: any[]): {
47
+ _objects: FabricObject[];
48
+ _onObjectAdded(object: FabricObject): void;
49
+ _onObjectRemoved(object: FabricObject): void;
50
+ _onStackOrderChanged(object: FabricObject): void;
51
+ add(...objects: FabricObject[]): number;
52
+ insertAt(index: number, ...objects: FabricObject[]): number;
53
+ remove(...objects: FabricObject[]): FabricObject[];
54
+ forEachObject(callback: (object: FabricObject, index: number, array: FabricObject[]) => any): void;
55
+ getObjects(...types: string[]): FabricObject[];
56
+ item(index: number): FabricObject;
57
+ isEmpty(): boolean; /**
58
+ * Indicates whether toObject/toDatalessObject should include default values
59
+ * if set to false, takes precedence over the object value.
60
+ * @type Boolean
61
+ * @default
62
+ */
63
+ size(): number;
64
+ contains(object: FabricObject, deep?: boolean | undefined): boolean;
65
+ complexity(): number;
66
+ sendObjectToBack(object: FabricObject): boolean;
67
+ bringObjectToFront(object: FabricObject): boolean;
68
+ sendObjectBackwards(object: FabricObject, intersecting?: boolean | undefined): boolean;
69
+ bringObjectForward(object: FabricObject, intersecting?: boolean | undefined): boolean;
70
+ moveObjectTo(object: FabricObject, index: number): boolean;
71
+ findNewLowerIndex(object: FabricObject, idx: number, intersecting?: boolean | undefined): number;
72
+ findNewUpperIndex(object: FabricObject, idx: number, intersecting?: boolean | undefined): number;
73
+ collectObjects({ left, top, width, height }: import("../typedefs").TBBox, { includeIntersecting }?: {
74
+ includeIntersecting?: boolean | undefined;
75
+ }): import("../shapes/Object/InteractiveObject").InteractiveFabricObject<Partial<import("../shapes/Object/types").FabricObjectProps>, import("../shapes/Object/types").SerializedObjectProps, import("../EventTypeDefs").ObjectEvents>[];
76
+ };
77
+ } & {
78
+ new (): CommonMethods<CanvasEvents>;
79
+ };
80
+ /**
81
+ * Static canvas class
82
+ * @see {@link http://fabricjs.com/static_canvas|StaticCanvas demo}
83
+ * @fires before:render
84
+ * @fires after:render
85
+ * @fires canvas:cleared
86
+ * @fires object:added
87
+ * @fires object:removed
88
+ */
89
+ export declare class StaticCanvas<EventSpec extends StaticCanvasEvents = StaticCanvasEvents> extends StaticCanvas_base {
90
+ /**
91
+ * Background color of canvas instance.
92
+ * @type {(String|TFiller)}
93
+ * @default
94
+ */
95
+ backgroundColor: TFiller | string;
96
+ /**
97
+ * Background image of canvas instance.
98
+ * since 2.4.0 image caching is active, please when putting an image as background, add to the
99
+ * canvas property a reference to the canvas it is on. Otherwise the image cannot detect the zoom
100
+ * vale. As an alternative you can disable image objectCaching
101
+ * @type FabricObject
102
+ * @default
103
+ */
104
+ backgroundImage: FabricObject | null;
105
+ /**
106
+ * Overlay color of canvas instance.
107
+ * @since 1.3.9
108
+ * @type {(String|TFiller)}
109
+ * @default
110
+ */
111
+ overlayColor: TFiller | string;
112
+ /**
113
+ * Overlay image of canvas instance.
114
+ * since 2.4.0 image caching is active, please when putting an image as overlay, add to the
115
+ * canvas property a reference to the canvas it is on. Otherwise the image cannot detect the zoom
116
+ * vale. As an alternative you can disable image objectCaching
117
+ * @type FabricObject
118
+ * @default
119
+ */
120
+ overlayImage: FabricObject | null;
121
+ /**
122
+ * Indicates whether toObject/toDatalessObject should include default values
123
+ * if set to false, takes precedence over the object value.
124
+ * @type Boolean
125
+ * @default
126
+ */
127
+ includeDefaultValues: boolean;
128
+ /**
129
+ * Indicates whether {@link add}, {@link insertAt} and {@link remove},
130
+ * {@link moveTo}, {@link clear} and many more, should also re-render canvas.
131
+ * Disabling this option will not give a performance boost when adding/removing a lot of objects to/from canvas at once
132
+ * since the renders are queued and executed one per frame.
133
+ * Disabling is suggested anyway and managing the renders of the app manually is not a big effort ( canvas.requestRenderAll() )
134
+ * Left default to true to do not break documentation and old app, fiddles.
135
+ * @type Boolean
136
+ * @default
137
+ */
138
+ renderOnAddRemove: boolean;
139
+ /**
140
+ * Indicates whether object controls (borders/controls) are rendered above overlay image
141
+ * @type Boolean
142
+ * @default
143
+ */
144
+ controlsAboveOverlay: boolean;
145
+ /**
146
+ * Indicates whether the browser can be scrolled when using a touchscreen and dragging on the canvas
147
+ * @type Boolean
148
+ * @default
149
+ */
150
+ allowTouchScrolling: boolean;
151
+ /**
152
+ * Indicates whether this canvas will use image smoothing, this is on by default in browsers
153
+ * @type Boolean
154
+ * @default
155
+ */
156
+ imageSmoothingEnabled: boolean;
157
+ /**
158
+ * The transformation (a Canvas 2D API transform matrix) which focuses the viewport
159
+ * @type Array
160
+ * @example <caption>Default transform</caption>
161
+ * canvas.viewportTransform = [1, 0, 0, 1, 0, 0];
162
+ * @example <caption>Scale by 70% and translate toward bottom-right by 50, without skewing</caption>
163
+ * canvas.viewportTransform = [0.7, 0, 0, 0.7, 50, 50];
164
+ * @default
165
+ */
166
+ viewportTransform: TMat2D;
167
+ /**
168
+ * if set to false background image is not affected by viewport transform
169
+ * @since 1.6.3
170
+ * @type Boolean
171
+ * @todo we should really find a different way to do this
172
+ * @default
173
+ */
174
+ backgroundVpt: boolean;
175
+ /**
176
+ * if set to false overlya image is not affected by viewport transform
177
+ * @since 1.6.3
178
+ * @type Boolean
179
+ * @todo we should really find a different way to do this
180
+ * @default
181
+ */
182
+ overlayVpt: boolean;
183
+ /**
184
+ * When true, canvas is scaled by devicePixelRatio for better rendering on retina screens
185
+ * @type Boolean
186
+ * @default
187
+ */
188
+ enableRetinaScaling: boolean;
189
+ /**
190
+ * Describe canvas element extension over design
191
+ * properties are tl,tr,bl,br.
192
+ * if canvas is not zoomed/panned those points are the four corner of canvas
193
+ * if canvas is viewportTransformed you those points indicate the extension
194
+ * of canvas element in plain untrasformed coordinates
195
+ * The coordinates get updated with @method calcViewportBoundaries.
196
+ */
197
+ vptCoords: TCornerPoint;
198
+ /**
199
+ * Based on vptCoords and object.aCoords, skip rendering of objects that
200
+ * are not included in current viewport.
201
+ * May greatly help in applications with crowded canvas and use of zoom/pan
202
+ * If One of the corner of the bounding box of the object is on the canvas
203
+ * the objects get rendered.
204
+ * @type Boolean
205
+ * @default true
206
+ */
207
+ skipOffscreen: boolean;
208
+ /**
209
+ * a fabricObject that, without stroke define a clipping area with their shape. filled in black
210
+ * the clipPath object gets used when the canvas has rendered, and the context is placed in the
211
+ * top left corner of the canvas.
212
+ * clipPath will clip away controls, if you do not want this to happen use controlsAboveOverlay = true
213
+ * @type FabricObject
214
+ */
215
+ clipPath: FabricObject;
216
+ /**
217
+ * A reference to the canvas actual HTMLCanvasElement.
218
+ * Can be use to read the raw pixels, but never write or manipulate
219
+ * @type HTMLCanvasElement
220
+ */
221
+ get lowerCanvasEl(): HTMLCanvasElement;
222
+ get contextContainer(): CanvasRenderingContext2D;
223
+ /**
224
+ * Width in virtual/logical pixels of the canvas.
225
+ * The canvas can be larger than width if retina scaling is active
226
+ * @type number
227
+ */
228
+ width: number;
229
+ /**
230
+ * Height in virtual/logical pixels of the canvas.
231
+ * The canvas can be taller than width if retina scaling is active
232
+ * @type height
233
+ */
234
+ height: number;
235
+ /**
236
+ * If true the Canvas is in the process or has been disposed/destroyed.
237
+ * No more rendering operation will be executed on this canvas.
238
+ * @type boolean
239
+ */
240
+ destroyed?: boolean;
241
+ /**
242
+ * Started the process of disposing but not done yet.
243
+ * WIll likely complete the render cycle already scheduled but stopping adding more.
244
+ * @type boolean
245
+ */
246
+ disposed?: boolean;
247
+ _offset: {
248
+ left: number;
249
+ top: number;
250
+ };
251
+ protected hasLostContext: boolean;
252
+ protected nextRenderHandle: number;
253
+ elements: StaticCanvasDOMManager;
254
+ static ownDefaults: Record<string, any>;
255
+ protected __cleanupTask?: {
256
+ (): void;
257
+ kill: (reason?: any) => void;
258
+ };
259
+ static getDefaults(): Record<string, any>;
260
+ constructor(el: string | HTMLCanvasElement, options?: {});
261
+ protected initElements(el: string | HTMLCanvasElement): void;
262
+ add(...objects: FabricObject[]): number;
263
+ insertAt(index: number, ...objects: FabricObject[]): number;
264
+ remove(...objects: FabricObject[]): FabricObject[];
265
+ _onObjectAdded(obj: FabricObject): void;
266
+ _onObjectRemoved(obj: FabricObject): void;
267
+ _onStackOrderChanged(): void;
268
+ /**
269
+ * @private
270
+ */
271
+ _isRetinaScaling(): boolean;
272
+ /**
273
+ * @private
274
+ * @return {Number} retinaScaling if applied, otherwise 1;
275
+ */
276
+ getRetinaScaling(): number;
277
+ /**
278
+ * Calculates canvas element offset relative to the document
279
+ * This method is also attached as "resize" event handler of window
280
+ */
281
+ calcOffset(): {
282
+ left: number;
283
+ top: number;
284
+ };
285
+ /**
286
+ * Returns canvas width (in px)
287
+ * @return {Number}
288
+ */
289
+ getWidth(): number;
290
+ /**
291
+ * Returns canvas height (in px)
292
+ * @return {Number}
293
+ */
294
+ getHeight(): number;
295
+ /**
296
+ * Sets width of this canvas instance
297
+ * @param {Number|String} value Value to set width to
298
+ * @param {Object} [options] Options object
299
+ * @param {Boolean} [options.backstoreOnly=false] Set the given dimensions only as canvas backstore dimensions
300
+ * @param {Boolean} [options.cssOnly=false] Set the given dimensions only as css dimensions
301
+ * @deprecated will be removed in 7.0
302
+ */
303
+ setWidth(value: number, options: TCanvasSizeOptions): void;
304
+ /**
305
+ * Sets height of this canvas instance
306
+ * @param {Number|String} value Value to set height to
307
+ * @param {Object} [options] Options object
308
+ * @param {Boolean} [options.backstoreOnly=false] Set the given dimensions only as canvas backstore dimensions
309
+ * @param {Boolean} [options.cssOnly=false] Set the given dimensions only as css dimensions
310
+ * @deprecated will be removed in 7.0
311
+ */
312
+ setHeight(value: number, options: TCanvasSizeOptions): void;
313
+ /**
314
+ * Internal use only
315
+ * @protected
316
+ */
317
+ protected _setDimensionsImpl(dimensions: Partial<TSize | CSSDimensions>, { cssOnly, backstoreOnly }?: TCanvasSizeOptions): void;
318
+ /**
319
+ * Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em)
320
+ * @param {Object} dimensions Object with width/height properties
321
+ * @param {Number|String} [dimensions.width] Width of canvas element
322
+ * @param {Number|String} [dimensions.height] Height of canvas element
323
+ * @param {Object} [options] Options object
324
+ * @param {Boolean} [options.backstoreOnly=false] Set the given dimensions only as canvas backstore dimensions
325
+ * @param {Boolean} [options.cssOnly=false] Set the given dimensions only as css dimensions
326
+ */
327
+ setDimensions(dimensions: Partial<TSize>, { cssOnly, backstoreOnly }?: TCanvasSizeOptions): void;
328
+ /**
329
+ * Returns canvas zoom level
330
+ * @return {Number}
331
+ */
332
+ getZoom(): number;
333
+ /**
334
+ * Sets viewport transformation of this canvas instance
335
+ * @param {Array} vpt a Canvas 2D API transform matrix
336
+ */
337
+ setViewportTransform(vpt: TMat2D): void;
338
+ /**
339
+ * Sets zoom level of this canvas instance, the zoom centered around point
340
+ * meaning that following zoom to point with the same point will have the visual
341
+ * effect of the zoom originating from that point. The point won't move.
342
+ * It has nothing to do with canvas center or visual center of the viewport.
343
+ * @param {Point} point to zoom with respect to
344
+ * @param {Number} value to set zoom to, less than 1 zooms out
345
+ */
346
+ zoomToPoint(point: Point, value: number): void;
347
+ /**
348
+ * Sets zoom level of this canvas instance
349
+ * @param {Number} value to set zoom to, less than 1 zooms out
350
+ */
351
+ setZoom(value: number): void;
352
+ /**
353
+ * Pan viewport so as to place point at top left corner of canvas
354
+ * @param {Point} point to move to
355
+ */
356
+ absolutePan(point: Point): void;
357
+ /**
358
+ * Pans viewpoint relatively
359
+ * @param {Point} point (position vector) to move by
360
+ */
361
+ relativePan(point: Point): void;
362
+ /**
363
+ * Returns &lt;canvas> element corresponding to this instance
364
+ * @return {HTMLCanvasElement}
365
+ */
366
+ getElement(): HTMLCanvasElement;
367
+ /**
368
+ * Clears specified context of canvas element
369
+ * @param {CanvasRenderingContext2D} ctx Context to clear
370
+ */
371
+ clearContext(ctx: CanvasRenderingContext2D): void;
372
+ /**
373
+ * Returns context of canvas where objects are drawn
374
+ * @return {CanvasRenderingContext2D}
375
+ */
376
+ getContext(): CanvasRenderingContext2D;
377
+ /**
378
+ * Clears all contexts (background, main, top) of an instance
379
+ */
380
+ clear(): void;
381
+ /**
382
+ * Renders the canvas
383
+ */
384
+ renderAll(): void;
385
+ /**
386
+ * Function created to be instance bound at initialization
387
+ * used in requestAnimationFrame rendering
388
+ * Let the fabricJS call it. If you call it manually you could have more
389
+ * animationFrame stacking on to of each other
390
+ * for an imperative rendering, use canvas.renderAll
391
+ * @private
392
+ */
393
+ renderAndReset(): void;
394
+ /**
395
+ * Append a renderAll request to next animation frame.
396
+ * unless one is already in progress, in that case nothing is done
397
+ * a boolean flag will avoid appending more.
398
+ */
399
+ requestRenderAll(): void;
400
+ /**
401
+ * Calculate the position of the 4 corner of canvas with current viewportTransform.
402
+ * helps to determinate when an object is in the current rendering viewport using
403
+ * object absolute coordinates ( aCoords )
404
+ * @return {Object} points.tl
405
+ * @chainable
406
+ */
407
+ calcViewportBoundaries(): TCornerPoint;
408
+ cancelRequestedRender(): void;
409
+ drawControls(ctx: CanvasRenderingContext2D): void;
410
+ /**
411
+ * Renders background, objects, overlay and controls.
412
+ * @param {CanvasRenderingContext2D} ctx
413
+ * @param {Array} objects to render
414
+ */
415
+ renderCanvas(ctx: CanvasRenderingContext2D, objects: FabricObject[]): void;
416
+ /**
417
+ * Paint the cached clipPath on the lowerCanvasEl
418
+ * @param {CanvasRenderingContext2D} ctx Context to render on
419
+ */
420
+ drawClipPathOnCanvas(ctx: CanvasRenderingContext2D, clipPath: TCachedFabricObject): void;
421
+ /**
422
+ * @private
423
+ * @param {CanvasRenderingContext2D} ctx Context to render on
424
+ * @param {Array} objects to render
425
+ */
426
+ _renderObjects(ctx: CanvasRenderingContext2D, objects: FabricObject[]): void;
427
+ /**
428
+ * @private
429
+ * @param {CanvasRenderingContext2D} ctx Context to render on
430
+ * @param {string} property 'background' or 'overlay'
431
+ */
432
+ _renderBackgroundOrOverlay(ctx: CanvasRenderingContext2D, property: 'background' | 'overlay'): void;
433
+ /**
434
+ * @private
435
+ * @param {CanvasRenderingContext2D} ctx Context to render on
436
+ */
437
+ _renderBackground(ctx: CanvasRenderingContext2D): void;
438
+ /**
439
+ * @private
440
+ * @param {CanvasRenderingContext2D} ctx Context to render on
441
+ */
442
+ _renderOverlay(ctx: CanvasRenderingContext2D): void;
443
+ /**
444
+ * Returns coordinates of a center of canvas.
445
+ * Returned value is an object with top and left properties
446
+ * @return {Object} object with "top" and "left" number values
447
+ * @deprecated migrate to `getCenterPoint`
448
+ */
449
+ getCenter(): {
450
+ top: number;
451
+ left: number;
452
+ };
453
+ /**
454
+ * Returns coordinates of a center of canvas.
455
+ * @return {Point}
456
+ */
457
+ getCenterPoint(): Point;
458
+ /**
459
+ * Centers object horizontally in the canvas
460
+ */
461
+ centerObjectH(object: FabricObject): void;
462
+ /**
463
+ * Centers object vertically in the canvas
464
+ * @param {FabricObject} object Object to center vertically
465
+ */
466
+ centerObjectV(object: FabricObject): void;
467
+ /**
468
+ * Centers object vertically and horizontally in the canvas
469
+ * @param {FabricObject} object Object to center vertically and horizontally
470
+ */
471
+ centerObject(object: FabricObject): void;
472
+ /**
473
+ * Centers object vertically and horizontally in the viewport
474
+ * @param {FabricObject} object Object to center vertically and horizontally
475
+ */
476
+ viewportCenterObject(object: FabricObject): void;
477
+ /**
478
+ * Centers object horizontally in the viewport, object.top is unchanged
479
+ * @param {FabricObject} object Object to center vertically and horizontally
480
+ */
481
+ viewportCenterObjectH(object: FabricObject): void;
482
+ /**
483
+ * Centers object Vertically in the viewport, object.top is unchanged
484
+ * @param {FabricObject} object Object to center vertically and horizontally
485
+ */
486
+ viewportCenterObjectV(object: FabricObject): void;
487
+ /**
488
+ * Calculate the point in canvas that correspond to the center of actual viewport.
489
+ * @return {Point} vpCenter, viewport center
490
+ */
491
+ getVpCenter(): Point;
492
+ /**
493
+ * @private
494
+ * @param {FabricObject} object Object to center
495
+ * @param {Point} center Center point
496
+ */
497
+ _centerObject(object: FabricObject, center: Point): void;
498
+ /**
499
+ * Returns dataless JSON representation of canvas
500
+ * @param {Array} [propertiesToInclude] Any properties that you might want to additionally include in the output
501
+ * @return {String} json string
502
+ */
503
+ toDatalessJSON(propertiesToInclude?: string[]): any;
504
+ /**
505
+ * Returns object representation of canvas
506
+ * @param {Array} [propertiesToInclude] Any properties that you might want to additionally include in the output
507
+ * @return {Object} object representation of an instance
508
+ */
509
+ toObject(propertiesToInclude?: string[]): any;
510
+ /**
511
+ * Returns Object representation of canvas
512
+ * this alias is provided because if you call JSON.stringify on an instance,
513
+ * the toJSON object will be invoked if it exists.
514
+ * Having a toJSON method means you can do JSON.stringify(myCanvas)
515
+ * @return {Object} JSON compatible object
516
+ * @tutorial {@link http://fabricjs.com/fabric-intro-part-3#serialization}
517
+ * @see {@link http://jsfiddle.net/fabricjs/pec86/|jsFiddle demo}
518
+ * @example <caption>JSON without additional properties</caption>
519
+ * var json = canvas.toJSON();
520
+ * @example <caption>JSON with additional properties included</caption>
521
+ * var json = canvas.toJSON(['lockMovementX', 'lockMovementY', 'lockRotation', 'lockScalingX', 'lockScalingY']);
522
+ * @example <caption>JSON without default values</caption>
523
+ * var json = canvas.toJSON();
524
+ */
525
+ toJSON(): any;
526
+ /**
527
+ * Returns dataless object representation of canvas
528
+ * @param {Array} [propertiesToInclude] Any properties that you might want to additionally include in the output
529
+ * @return {Object} object representation of an instance
530
+ */
531
+ toDatalessObject(propertiesToInclude?: string[]): any;
532
+ /**
533
+ * @private
534
+ */
535
+ _toObjectMethod(methodName: TValidToObjectMethod, propertiesToInclude?: string[]): any;
536
+ /**
537
+ * @private
538
+ */
539
+ _toObject(instance: FabricObject, methodName: TValidToObjectMethod, propertiesToInclude?: string[]): any;
540
+ /**
541
+ * @private
542
+ */
543
+ __serializeBgOverlay(methodName: TValidToObjectMethod, propertiesToInclude?: string[]): any;
544
+ /**
545
+ * When true, getSvgTransform() will apply the StaticCanvas.viewportTransform to the SVG transformation. When true,
546
+ * a zoomed canvas will then produce zoomed SVG output.
547
+ * @type Boolean
548
+ * @default
549
+ */
550
+ svgViewportTransformation: boolean;
551
+ /**
552
+ * Returns SVG representation of canvas
553
+ * @function
554
+ * @param {Object} [options] Options object for SVG output
555
+ * @param {Boolean} [options.suppressPreamble=false] If true xml tag is not included
556
+ * @param {Object} [options.viewBox] SVG viewbox object
557
+ * @param {Number} [options.viewBox.x] x-coordinate of viewbox
558
+ * @param {Number} [options.viewBox.y] y-coordinate of viewbox
559
+ * @param {Number} [options.viewBox.width] Width of viewbox
560
+ * @param {Number} [options.viewBox.height] Height of viewbox
561
+ * @param {String} [options.encoding=UTF-8] Encoding of SVG output
562
+ * @param {String} [options.width] desired width of svg with or without units
563
+ * @param {String} [options.height] desired height of svg with or without units
564
+ * @param {Function} [reviver] Method for further parsing of svg elements, called after each fabric object converted into svg representation.
565
+ * @return {String} SVG string
566
+ * @tutorial {@link http://fabricjs.com/fabric-intro-part-3#serialization}
567
+ * @see {@link http://jsfiddle.net/fabricjs/jQ3ZZ/|jsFiddle demo}
568
+ * @example <caption>Normal SVG output</caption>
569
+ * var svg = canvas.toSVG();
570
+ * @example <caption>SVG output without preamble (without &lt;?xml ../>)</caption>
571
+ * var svg = canvas.toSVG({suppressPreamble: true});
572
+ * @example <caption>SVG output with viewBox attribute</caption>
573
+ * var svg = canvas.toSVG({
574
+ * viewBox: {
575
+ * x: 100,
576
+ * y: 100,
577
+ * width: 200,
578
+ * height: 300
579
+ * }
580
+ * });
581
+ * @example <caption>SVG output with different encoding (default: UTF-8)</caption>
582
+ * var svg = canvas.toSVG({encoding: 'ISO-8859-1'});
583
+ * @example <caption>Modify SVG output with reviver function</caption>
584
+ * var svg = canvas.toSVG(null, function(svg) {
585
+ * return svg.replace('stroke-dasharray: ; stroke-linecap: butt; stroke-linejoin: miter; stroke-miterlimit: 10; ', '');
586
+ * });
587
+ */
588
+ toSVG(options: TSVGExportOptions | undefined, reviver: TSVGReviver): string;
589
+ /**
590
+ * @private
591
+ */
592
+ _setSVGPreamble(markup: string[], options: TSVGExportOptions): void;
593
+ /**
594
+ * @private
595
+ */
596
+ _setSVGHeader(markup: string[], options: TSVGExportOptions): void;
597
+ createSVGClipPathMarkup(options: TSVGExportOptions): string;
598
+ /**
599
+ * Creates markup containing SVG referenced elements like patterns, gradients etc.
600
+ * @return {String}
601
+ */
602
+ createSVGRefElementsMarkup(): string;
603
+ /**
604
+ * Creates markup containing SVG font faces,
605
+ * font URLs for font faces must be collected by developers
606
+ * and are not extracted from the DOM by fabricjs
607
+ * @param {Array} objects Array of fabric objects
608
+ * @return {String}
609
+ */
610
+ createSVGFontFacesMarkup(): string;
611
+ /**
612
+ * @private
613
+ */
614
+ _setSVGObjects(markup: string[], reviver: TSVGReviver): void;
615
+ /**
616
+ * This is its own function because the Canvas ( non static ) requires extra code here
617
+ * @private
618
+ */
619
+ _setSVGObject(markup: string[], instance: FabricObject, reviver: TSVGReviver): void;
620
+ /**
621
+ * @private
622
+ */
623
+ _setSVGBgOverlayImage(markup: string[], property: 'overlayImage' | 'backgroundImage', reviver: TSVGReviver): void;
624
+ /**
625
+ * @TODO this seems to handle patterns but fail at gradients.
626
+ * @private
627
+ */
628
+ _setSVGBgOverlayColor(markup: string[], property: 'background' | 'overlay'): void;
629
+ /**
630
+ * Populates canvas with data from the specified JSON.
631
+ * JSON format must conform to the one of {@link fabric.Canvas#toJSON}
632
+ *
633
+ * **IMPORTANT**: It is recommended to abort loading tasks before calling this method to prevent race conditions and unnecessary networking
634
+ *
635
+ * @param {String|Object} json JSON string or object
636
+ * @param {Function} [reviver] Method for further parsing of JSON elements, called after each fabric object created.
637
+ * @param {Object} [options] options
638
+ * @param {AbortSignal} [options.signal] see https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal
639
+ * @return {Promise<Canvas | StaticCanvas>} instance
640
+ * @tutorial {@link http://fabricjs.com/fabric-intro-part-3#deserialization}
641
+ * @see {@link http://jsfiddle.net/fabricjs/fmgXt/|jsFiddle demo}
642
+ * @example <caption>loadFromJSON</caption>
643
+ * canvas.loadFromJSON(json).then((canvas) => canvas.requestRenderAll());
644
+ * @example <caption>loadFromJSON with reviver</caption>
645
+ * canvas.loadFromJSON(json, function(o, object) {
646
+ * // `o` = json object
647
+ * // `object` = fabric.Object instance
648
+ * // ... do some stuff ...
649
+ * }).then((canvas) => {
650
+ * ... canvas is restored, add your code.
651
+ * });
652
+ *
653
+ */
654
+ loadFromJSON(json: string | Record<string, any>, reviver?: EnlivenObjectOptions['reviver'], { signal }?: Abortable): Promise<this>;
655
+ /**
656
+ * Clones canvas instance
657
+ * @param {string[]} [properties] Array of properties to include in the cloned canvas and children
658
+ */
659
+ clone(properties: string[]): Promise<this>;
660
+ /**
661
+ * Clones canvas instance without cloning existing data.
662
+ * This essentially copies canvas dimensions since loadFromJSON does not affect canvas size.
663
+ */
664
+ cloneWithoutData(): this;
665
+ /**
666
+ * Exports canvas element to a dataurl image. Note that when multiplier is used, cropping is scaled appropriately
667
+ * @param {Object} [options] Options object
668
+ * @param {String} [options.format=png] The format of the output image. Either "jpeg" or "png"
669
+ * @param {Number} [options.quality=1] Quality level (0..1). Only used for jpeg.
670
+ * @param {Number} [options.multiplier=1] Multiplier to scale by, to have consistent
671
+ * @param {Number} [options.left] Cropping left offset. Introduced in v1.2.14
672
+ * @param {Number} [options.top] Cropping top offset. Introduced in v1.2.14
673
+ * @param {Number} [options.width] Cropping width. Introduced in v1.2.14
674
+ * @param {Number} [options.height] Cropping height. Introduced in v1.2.14
675
+ * @param {Boolean} [options.enableRetinaScaling] Enable retina scaling for clone image. Introduce in 2.0.0
676
+ * @param {(object: fabric.Object) => boolean} [options.filter] Function to filter objects.
677
+ * @return {String} Returns a data: URL containing a representation of the object in the format specified by options.format
678
+ * @see {@link https://jsfiddle.net/xsjua1rd/ demo}
679
+ * @example <caption>Generate jpeg dataURL with lower quality</caption>
680
+ * var dataURL = canvas.toDataURL({
681
+ * format: 'jpeg',
682
+ * quality: 0.8
683
+ * });
684
+ * @example <caption>Generate cropped png dataURL (clipping of canvas)</caption>
685
+ * var dataURL = canvas.toDataURL({
686
+ * format: 'png',
687
+ * left: 100,
688
+ * top: 100,
689
+ * width: 200,
690
+ * height: 200
691
+ * });
692
+ * @example <caption>Generate double scaled png dataURL</caption>
693
+ * var dataURL = canvas.toDataURL({
694
+ * format: 'png',
695
+ * multiplier: 2
696
+ * });
697
+ * @example <caption>Generate dataURL with objects that overlap a specified object</caption>
698
+ * var myObject;
699
+ * var dataURL = canvas.toDataURL({
700
+ * filter: (object) => object.isContainedWithinObject(myObject) || object.intersectsWithObject(myObject)
701
+ * });
702
+ */
703
+ toDataURL(options?: TDataUrlOptions): string;
704
+ /**
705
+ * Create a new HTMLCanvas element painted with the current canvas content.
706
+ * No need to resize the actual one or repaint it.
707
+ * Will transfer object ownership to a new canvas, paint it, and set everything back.
708
+ * This is an intermediary step used to get to a dataUrl but also it is useful to
709
+ * create quick image copies of a canvas without passing for the dataUrl string
710
+ * @param {Number} [multiplier] a zoom factor.
711
+ * @param {Object} [options] Cropping informations
712
+ * @param {Number} [options.left] Cropping left offset.
713
+ * @param {Number} [options.top] Cropping top offset.
714
+ * @param {Number} [options.width] Cropping width.
715
+ * @param {Number} [options.height] Cropping height.
716
+ * @param {(object: fabric.Object) => boolean} [options.filter] Function to filter objects.
717
+ */
718
+ toCanvasElement(multiplier?: number, { width, height, left, top, filter }?: TToCanvasElementOptions): HTMLCanvasElement;
719
+ /**
720
+ * Waits until rendering has settled to destroy the canvas
721
+ * @returns {Promise<boolean>} a promise resolving to `true` once the canvas has been destroyed or to `false` if the canvas has was already destroyed
722
+ * @throws if aborted by a consequent call
723
+ */
724
+ dispose(): Promise<boolean>;
725
+ /**
726
+ * Clears the canvas element, disposes objects and frees resources.
727
+ *
728
+ * Invoked as part of the **async** operation of {@link dispose}.
729
+ *
730
+ * **CAUTION**:
731
+ *
732
+ * This method is **UNSAFE**.
733
+ * You may encounter a race condition using it if there's a requested render.
734
+ * Call this method only if you are sure rendering has settled.
735
+ * Consider using {@link dispose} as it is **SAFE**
736
+ *
737
+ * @private
738
+ */
739
+ destroy(): void;
740
+ /**
741
+ * Returns a string representation of an instance
742
+ * @return {String} string representation of an instance
743
+ */
744
+ toString(): string;
745
+ }
746
+ export {};
747
+ //# sourceMappingURL=StaticCanvas.d.ts.map